az arcappliance

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

Commands to manage Arc resource bridge.

Commands

Name	Description	Type	Status
az arcappliance create	Command group for creation of the connection between the Arc resource bridge on-premises appliance VM and its corresponding Azure resource.	Extension	GA
az arcappliance create hci	Command to create the connection between the on-premises appliance VM and Azure resource for Arc resource bridge (Azure Stack HCI).	Extension	GA
az arcappliance create scvmm	Command to create the connection between the on-premises appliance VM and Azure resource for Arc resource bridge on SCVMM.	Extension	GA
az arcappliance create vmware	Command to create the connection between the on-premises appliance VM and Azure resource for Arc resource bridge (Arc-enabled VMware).	Extension	GA
az arcappliance createconfig	Command group for creating configuration files for Arc resource bridge.	Extension	GA
az arcappliance createconfig hci	Command to create configuration files for Arc Resource Bridge on HCI.	Extension	GA
az arcappliance createconfig scvmm	Command to create Arc resource bridge configuration files for Arc-enabled SCVMM.	Extension	GA
az arcappliance createconfig vmware	Command to create Arc resource bridge configuration files for Arc-enabled VMware.	Extension	GA
az arcappliance delete	Command group for deletion of an Arc resource bridge on-premises appliance VM and its Azure resource.	Extension	GA
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 deploy	Command group for deployment of the Arc resource bridge on-premises appliance VM and creation of its corresponding Azure resource.	Extension	GA
az arcappliance deploy hci	Command to deploy the Arc resource bridge's on-premises appliance VM on Azure Stack HCI and its corresponding Azure resource.	Extension	GA
az arcappliance deploy scvmm	Command to deploy the Arc resource bridge's on-premises appliance VM and its Azure resource for Arc-enabled SCVMM.	Extension	GA
az arcappliance deploy vmware	Command to deploy the Arc resource bridge's on-premises appliance VM on VMWare and its corresponding Azure resource.	Extension	GA
az arcappliance get-credentials	Command to get the on-premises infrastructure credentials used by Arc resource bridge to manage on-premises resources.	Extension	GA
az arcappliance get-upgrades	Command to fetch the available upgrades for an Appliance.	Extension	GA
az arcappliance list	Command to list Arc resource bridge resources.	Extension	GA
az arcappliance logs	Command group for collecting logs for Arc resource bridge. Run get-credentials command before running logs command.	Extension	GA
az arcappliance logs hci	Command to collect logs for an Appliance on Azure Stack HCI.	Extension	GA
az arcappliance logs scvmm	Command to collect logs for Arc resource bridge on SCVMM (Arc-enabled SCVMM).	Extension	GA
az arcappliance logs vmware	Command to collect logs for Appliance on VMware.	Extension	GA
az arcappliance notice	Command to display the EULA & Notice File link for Arc resource bridge.	Extension	GA
az arcappliance prepare	Command group for preparing for an Arc resource bridge deployment. This downloads the necessary images to build the on-premises appliance VM and uploads it to the private cloud gallery.	Extension	GA
az arcappliance prepare hci	Command to prepare the on-premises Azure Stack HCI environment for an Arc resource bridge deployment. This downloads the necessary images to build the on-premises appliance VM and uploads it to the private cloud gallery.	Extension	GA
az arcappliance prepare scvmm	Command to prepare for an Arc resource bridge deployment on SCVMM for Arc-enabled SCVMM. This downloads the necessary images to build the on-premises appliance VM and uploads it to the private cloud gallery.	Extension	GA
az arcappliance prepare vmware	Command to prepare for an Arc resource bridge deployment on VMware for Arc-enabled VMware. This downloads the necessary images to build the on-premises appliance VM and uploads it to the private cloud gallery.	Extension	GA
az arcappliance run	Command group for consecutively running the Arc resource bridge commands required for deployment. This command is idempotent.	Extension	GA
az arcappliance run hci	Command to consecutively run the Arc resource bridge commands required for deployment on Azure Stack HCI. This command is idempotent.	Extension	GA
az arcappliance run scvmm	Command to consecutively run the Arc resource bridge commands required for deployment on SCVMM. This command is idempotent.	Extension	GA
az arcappliance run vmware	Command to consecutively run the Arc resource bridge commands required for deployment on VMware (Arc-enabled VMware). This command is idempotent.	Extension	GA
az arcappliance show	Command to provide information about an Arc resource bridge Azure resource. This is useful to monitor the status of the resource bridge.	Extension	GA
az arcappliance troubleshoot	Command group for troubleshooting an Appliance cluster.	Extension	GA
az arcappliance troubleshoot command	Command group for troubleshooting an Appliance cluster by executing a shell command.	Extension	GA
az arcappliance troubleshoot command hci	Command to execute a shell command on an HCI cluster for troubleshooting. Either --ip or --kubeconfig must be provided. If both are passed in, --ip will be used.	Extension	GA
az arcappliance troubleshoot command scvmm	Command to execute a shell command on an SCVMM cluster for troubleshooting. Either --ip or --kubeconfig must be provided. If both are passed in, --ip will be used.	Extension	GA
az arcappliance troubleshoot command vmware	Command to execute a shell command on an VMWare cluster for troubleshooting. Either --ip or --kubeconfig must be provided. If both are passed in, --ip will be used.	Extension	GA
az arcappliance update-infracredentials	Command group for updating the on-premises infrastructure credentials used by Arc resource bridge to manage on-premises resources.	Extension	GA
az arcappliance update-infracredentials hci	Command to update the on-premises infrastructure credentials for Azure Stack HCI used by Arc resource bridge.	Extension	GA
az arcappliance update-infracredentials scvmm	Command to update the SCVMM credentials used by Arc resource bridge.	Extension	GA
az arcappliance update-infracredentials vmware	Command to update the VMware credentials used by Arc resource bridge.	Extension	GA
az arcappliance upgrade	Command group for upgrading an Appliance cluster.	Extension	GA
az arcappliance upgrade hci	Command to upgrade an Appliance on Azure Stack HCI.	Extension	GA
az arcappliance upgrade scvmm	Command to upgrade an Appliance on SCVMM.	Extension	GA
az arcappliance upgrade vmware	Command to upgrade an Appliance on VMware.	Extension	GA
az arcappliance validate	Command group to perform validations on Arc resource bridge configuration files and network settings.	Extension	GA
az arcappliance validate hci	Command to validate Arc resource bridge configuration files and network settings on Azure Stack HCI - should be done before 'prepare' command.	Extension	GA
az arcappliance validate scvmm	Command to validate Arc resource bridge configuration files and network settings for Arc-enabled SCVMM - should be done before 'prepare' command.	Extension	GA
az arcappliance validate vmware	Command to validate Arc resource bridge configuration files and network settings for Arc-enabled VMware - should be done before 'prepare' command.	Extension	GA

az arcappliance get-credentials

Command to get the on-premises infrastructure credentials used by Arc resource bridge to manage on-premises resources.

az arcappliance get-credentials [--config-file]
                                [--credentials-dir]
                                [--name]
                                [--overwrite-existing {false, true}]
                                [--partner {false, true}]
                                [--resource-group]
                                [--yes {false, true}]

Examples

Command to get user credentials using resource name and resource group and write them to a dir.

az arcappliance get-credentials --resource-group [REQUIRED] --name [REQUIRED] --credentials-dir [OPTIONAL]

Command to get user credentials using config file and write them to a dir.

az arcappliance get-credentials --config-file [REQUIRED] --credentials-dir [OPTIONAL]

Command to get user credentials using config file and write them to a dir which does not exist, and create the dir without prompting.

az arcappliance get-credentials --config-file [REQUIRED] --credentials-dir [OPTIONAL] --y [OPTIONAL]

Command to get user credentials and write them to a file. Overwrite files if they exist.

az arcappliance get-credentials --resource-group [REQUIRED] --name [REQUIRED] --credentials-dir [OPTIONAL] --overwrite-existing [OPTIONAL]

Command to get partner credentials used by private cloud RP/service to access Arc Resource Bridge. Credentials will be printed to Stdout.

az arcappliance get-credentials --resource-group [REQUIRED] --name [REQUIRED] --partner [OPTIONAL]

Optional Parameters

--config-file

Path to Appliance Config File. This is required if name and resource group are not specified.

--credentials-dir

Specify a directory path where the log key, certificate output and kubeconfig are saved. If no value specified, for Darwin/Linux defaults to .kva/.ssh for keys and current directory for kubeconfig,for windows defaults to C:\ProgramData\kva.ssh for keys and current directory for kubeconfig.

--name -n

Name of the Arc resource bridge.

--overwrite-existing

Overwrite existing kubeconfig file. Default: False.

Accepted values: false, true

Default value: False

--partner

Returns the credentials used by private cloud RP/service to access Arc Resource Bridge. Default: customer user credentials.

Accepted values: false, true

Default value: False

--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 to create credentials_dir if directory does not exist. Default is to prompt for directory creation.

Accepted values: false, true

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

Command to fetch the available upgrades for an Appliance.

az arcappliance get-upgrades --name
                             --resource-group

Examples

Fetch the available upgrades for a specific Appliance.

az arcappliance get-upgrades --resource-group [REQUIRED] --name [REQUIRED]

Required Parameters

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

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 list

Command to list Arc resource bridge resources.

az arcappliance list [--resource-group]

Examples

Command to list Arc resource bridge resources in a resource group in the current subscription.

az arcappliance list -g [OPTIONAL]

Optional Parameters

--resource-group -g

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

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 notice

Command to display the EULA & Notice File link for Arc resource bridge.

az arcappliance notice

Examples

Displays the EULA & Notice File link for Arc resource bridge.

az arcappliance notice

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 show

Command to provide information about an Arc resource bridge Azure resource. This is useful to monitor the status of the resource bridge.

az arcappliance show --name
                     --resource-group

Examples

Command to show details about a particular Arc resource bridge in a resource group.

az arcappliance show --resource-group [REQUIRED] --name [REQUIRED]

Required Parameters

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

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.