az arcappliance deploy
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 deploy command. Learn more about extensions.
Command group for deployment of the Arc resource bridge on-premises appliance VM and creation of its corresponding Azure resource.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| 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 deploy hci
Command to deploy the Arc resource bridge's on-premises appliance VM on Azure Stack HCI and its corresponding Azure resource.
az arcappliance deploy hci --config-file
[--cloudagent]
[--location]
[--loginconfigfile]
[--name]
[--outfile]
[--resource-group]
[--tags]Examples
Deploy Arc resource bridge on Azure Stack HCI
az arcappliance deploy hci --config-file [REQUIRED]Deploy Arc resource bridge on Azure Stack HCI with a specified outfile for the kubeconfig
az arcappliance deploy hci --config-file [REQUIRED] --outfile [OPTIONAL] --cloudagent [OPTIONAL] --loginconfigfile [OPTIONAL]Required Parameters
Path to the Arc resource bridge appliance config file, -appliance.yaml.
Optional Parameters
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. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
File path for the Azure Stack HCI login configuration file, kvatoken.tok. By default, it is stored locally on the HCI cluster.
Name of the Arc resource bridge.
File output path for the kubeconfig, defaults to ./kubeconfig.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az arcappliance deploy scvmm
Command to deploy the Arc resource bridge's on-premises appliance VM and its Azure resource for Arc-enabled SCVMM.
az arcappliance deploy scvmm --config-file
[--address]
[--location]
[--name]
[--outfile]
[--password]
[--port]
[--resource-group]
[--tags]
[--username]Examples
Deploy Arc resource bridge on SCVMM
az arcappliance deploy scvmm --config-file [REQUIRED]Deploy Arc resource bridge on SCVMM with a specified outfile for the kubeconfig
az arcappliance deploy scvmm --config-file [REQUIRED] --outfile [OPTIONAL] --tags [OPTIONAL] --address [OPTIONAL] --port [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]Required Parameters
Path to the Arc resource bridge appliance config file, -appliance.yaml.
Optional Parameters
SCVMM Server FQDN (e.g. vmmuser001.contoso.lab) or IPv4 address. If you have a Highly Available VMM setup, enter the role name.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
Name of the Arc resource bridge.
File output path for the kubeconfig, defaults to ./kubeconfig.
SCVMM Administrator Password.
SCVMM server port number (Default: 8100).
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
SCVMM Administrator Username in the format domain\username where 'domain' should be the NetBIOS name of the domain (e.g. contoso\administrator).
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az arcappliance deploy vmware
Command to deploy the Arc resource bridge's on-premises appliance VM on VMWare and its corresponding Azure resource.
az arcappliance deploy vmware --config-file
[--address]
[--location]
[--name]
[--outfile]
[--password]
[--resource-group]
[--tags]
[--username]Examples
Deploy Arc resource bridge on VMware
az arcappliance deploy vmware --config-file [REQUIRED]Deploy Arc resource bridge on VMware with a specified outfile for the kubeconfig
az arcappliance deploy vmware --config-file [REQUIRED] --outfile [OPTIONAL] --address [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]Required Parameters
Path to the Arc resource bridge appliance config file, -appliance.yaml.
Optional Parameters
FQDN or IP address for vCenter Server instance. Ex: 10.160.0.1.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
Name of the Arc resource bridge.
File output path for the kubeconfig, defaults to ./kubeconfig.
Password for vSphere account that Arc resource bridge uses for on-premises infrastructure guest management.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Username for vSphere account that Arc resource bridge uses for on-premises infrastructure guest management.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for