Share via

az arcappliance configuration proxy update

  • Preview

Note

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

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command group for updating proxy configuration on Arc resource bridge.

Commands

Name Description Type Status
az arcappliance configuration proxy update hci

Command to update the proxy configuration for Arc resource bridge on Azure Stack HCI.

 Extension Preview
az arcappliance configuration proxy update vmware

Command to update the proxy configuration for Arc resource bridge on VMware.

 Extension Preview

az arcappliance configuration proxy update hci

Preview

Command group 'arcappliance configuration proxy update' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command to update the proxy configuration for Arc resource bridge on Azure Stack HCI.

az arcappliance configuration proxy update hci --name
                                               --resource-group
                                               [--certificateFilePath]
                                               [--credentials-dir]
                                               [--disable-proxy]
                                               [--http]
                                               [--https]
                                               [--no-certificate]
                                               [--no-http]
                                               [--no-https]
                                               [--noproxy]

Examples

Enable or update proxy configuration for Arc resource bridge on Azure Stack HCI

az arcappliance configuration proxy update hci --resource-group [REQUIRED] --name [REQUIRED] --credentials-dir [REQUIRED] --http 'http://my-proxy.company.com:8080' --https 'http://my-proxy.company.com:8080' --noproxy [REQUIRED] --certificateFilePath 'proxy-cert.pem'

Enable or update proxy configuration without HTTPS proxy or SSL cert for Arc resource bridge on Azure Stack HCI

az arcappliance configuration proxy update hci --resource-group [REQUIRED] --name [REQUIRED] --credentials-dir [REQUIRED] --http 'http://my-proxy.company.com:8080' --no-https --noproxy [REQUIRED] --no-certificate

Disable proxy configuration for Arc resource bridge on Azure Stack HCI

az arcappliance configuration proxy update hci --resource-group [REQUIRED] --name [REQUIRED] --credentials-dir [REQUIRED] --disable-proxy

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--certificateFilePath

Certificate file path if your proxy server requires the proxy clients to trust a certificate.

--credentials-dir

This is the path to the credentials directory, which stores credentials for your Resource Bridge. Use the az arcappliance get-credentials command to download it.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.

--disable-proxy

Disable the proxy configuration.

Property Value
Default value: False
--http

HTTP proxy URL and port information entered as http://<URL>:<PORT>. Example: http://192.168.0.10:80.

--https

HTTPS URL and port information entered as http://<URL>:<PORT>. Example: https://192.168.0.10:443.

--no-certificate

Disable the proxy certificate setting.

Property Value
Default value: False
--no-http

Disable the HTTP proxy setting.

Property Value
Default value: False
--no-https

Disable the HTTPS proxy setting.

Property Value
Default value: False
--noproxy

The list of comma separated entries for excluded networks, hosts, or domains from being accessed through the proxy server.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az arcappliance configuration proxy update vmware

Preview

Command group 'arcappliance configuration proxy update' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command to update the proxy configuration for Arc resource bridge on VMware.

az arcappliance configuration proxy update vmware --name
                                                  --resource-group
                                                  [--certificateFilePath]
                                                  [--credentials-dir]
                                                  [--disable-proxy]
                                                  [--http]
                                                  [--https]
                                                  [--no-certificate]
                                                  [--no-http]
                                                  [--no-https]
                                                  [--noproxy]

Examples

Enable or update proxy configuration for Arc resource bridge on VMware

az arcappliance configuration proxy update vmware --resource-group [REQUIRED] --name [REQUIRED] --credentials-dir [REQUIRED] --http 'http://my-proxy.company.com:8080' --https 'http://my-proxy.company.com:8080' --noproxy [REQUIRED] --certificateFilePath 'proxy-cert.pem'

Enable or update proxy configuration without HTTPS proxy or SSL cert for Arc resource bridge on VMware

az arcappliance configuration proxy update vmware --resource-group [REQUIRED] --name [REQUIRED] --credentials-dir [REQUIRED] --http 'http://my-proxy.company.com:8080' --no-https --noproxy [REQUIRED] --no-certificate

Disable proxy configuration for Arc resource bridge on VMware

az arcappliance configuration proxy update vmware --resource-group [REQUIRED] --name [REQUIRED] --credentials-dir [REQUIRED] --disable-proxy

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--certificateFilePath

Certificate file path if your proxy server requires the proxy clients to trust a certificate.

--credentials-dir

This is the path to the credentials directory, which stores credentials for your Resource Bridge. Use the az arcappliance get-credentials command to download it.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.

--disable-proxy

Disable the proxy configuration.

Property Value
Default value: False
--http

HTTP proxy URL and port information entered as http://<URL>:<PORT>. Example: http://192.168.0.10:80.

--https

HTTPS URL and port information entered as http://<URL>:<PORT>. Example: https://192.168.0.10:443.

--no-certificate

Disable the proxy certificate setting.

Property Value
Default value: False
--no-http

Disable the HTTP proxy setting.

Property Value
Default value: False
--no-https

Disable the HTTPS proxy setting.

Property Value
Default value: False
--noproxy

The list of comma separated entries for excluded networks, hosts, or domains from being accessed through the proxy server.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False