Share via


az arcappliance delete

Note

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

Command group for deletion of an Arc resource bridge on-premises appliance VM and its Azure resource.

Commands

Name Description Type Status
az arcappliance delete hci

Command to delete the on-premises appliance VM on Azure Stack HCI and Arc resource bridge Azure resource.

Extension GA
az arcappliance delete scvmm

Command to delete the on-premises appliance VM on SCVMM and Azure resource.

Extension GA
az arcappliance delete vmware

Command to delete the on-premises appliance VM and Azure resource for Arc resource bridge (Arc-enabled VMware).

Extension GA

az arcappliance delete hci

Command to delete the on-premises appliance VM on Azure Stack HCI and Arc resource bridge Azure resource.

az arcappliance delete hci --config-file
                           [--cloudagent]
                           [--location]
                           [--loginconfigfile]
                           [--name]
                           [--resource-group]
                           [--yes]

Examples

Delete Arc resource bridge from Azure Stack HCI

az arcappliance delete hci --config-file [REQUIRED] --cloudagent [OPTIONAL] --loginconfigfile [OPTIONAL]

Required Parameters

--config-file

Path to the Arc resource bridge appliance config file, -appliance.yaml.

Optional Parameters

--cloudagent

FQDN or IP address of the Azure Stack HCI MOC cloud agent service used by Arc resource bridge. This can be found in the -infra.yaml configuration file stored locally on the HCI cluster.

--location -l

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

--loginconfigfile

File path for the Azure Stack HCI login configuration file, kvatoken.tok. By default, it is stored locally on the HCI cluster.

--name -n

Name of the Arc resource bridge.

--resource-group -g

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

--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 arcappliance delete scvmm

Command to delete the on-premises appliance VM on SCVMM and Azure resource.

az arcappliance delete scvmm --config-file
                             [--address]
                             [--location]
                             [--name]
                             [--password]
                             [--port]
                             [--resource-group]
                             [--username]
                             [--yes]

Examples

Delete Arc resource bridge from SCVMM

az arcappliance delete scvmm --config-file [REQUIRED] --address [OPTIONAL] --port [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]

Required Parameters

--config-file

Path to the Arc resource bridge appliance config file, -appliance.yaml.

Optional Parameters

--address

SCVMM Server FQDN (e.g. vmmuser001.contoso.lab) or IPv4 address. If you have a Highly Available VMM setup, enter the role name.

--location -l

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

--name -n

Name of the Arc resource bridge.

--password

SCVMM Administrator Password.

--port

SCVMM server port number (Default: 8100).

--resource-group -g

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

--username

SCVMM Administrator Username in the format domain\username where 'domain' should be the NetBIOS name of the domain (e.g. contoso\administrator).

--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 arcappliance delete vmware

Command to delete the on-premises appliance VM and Azure resource for Arc resource bridge (Arc-enabled VMware).

az arcappliance delete vmware --config-file
                              [--address]
                              [--location]
                              [--name]
                              [--password]
                              [--resource-group]
                              [--username]
                              [--yes]

Examples

Delete Appliance VMware Resource

az arcappliance delete vmware --config-file [REQUIRED] --address [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]

Required Parameters

--config-file

Path to the Arc resource bridge appliance config file, -appliance.yaml.

Optional Parameters

--address

FQDN or IP address for vCenter Server instance. Ex: 10.160.0.1.

--location -l

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

--name -n

Name of the Arc resource bridge.

--password

Password for vSphere account that Arc resource bridge uses for on-premises infrastructure guest management.

--resource-group -g

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

--username

Username for vSphere account that Arc resource bridge uses for on-premises infrastructure guest management.

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