Share via

az sphere device network proxy

  • Reference

Note

This reference is part of the azure-sphere extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an az sphere device network proxy command. Learn more about extensions.

Manage proxy address use for network connection.

Commands

Name Description Type Status
az sphere device network proxy apply

Configure the network proxy on the attached device.

 Extension GA
az sphere device network proxy delete

Delete proxy connection on the attached device.

 Extension GA
az sphere device network proxy disable

Disable network proxy on the attached device.

 Extension GA
az sphere device network proxy enable

Enable network proxy on the attached device.

 Extension GA
az sphere device network proxy show

Show proxy connection on the attached device.

 Extension GA

az sphere device network proxy apply

Configure the network proxy on the attached device.

az sphere device network proxy apply --address
                                     --authentication
                                     --port
                                     [--device]
                                     [--enable]
                                     [--no-proxy-addresses]
                                     [--password]
                                     [--username]

Examples

Apply a Network Proxy with Basic Authentication

az sphere device network proxy apply --address contoso.com --authentication basic --port 8080 --username ExampleUsername --password ExamplePassword --no-proxy-addresses badcontoso.com badcontoso2.com --enable

Apply a Network Proxy with Anonymous Authentication

az sphere device network proxy apply --address contoso.com --authentication anonymous --port 8080 --enable --device 192.168.35.2

Required Parameters

--address -a

The network address of the proxy.

--authentication -t

If the proxy requires a user name and password, set this to basic, otherwise anonymous. Allowed values are anonymous, basic.

--port -r

The port on the network address to be used.

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Value from: az sphere device list-attached
--enable

Enable the network proxy configuration on the attached device.

Default value: False
--no-proxy-addresses -n

Array of space-separated network addresses the device should avoid for proxy connection.

Default value: []
--password -p

For Basic Authentication, password used for proxy authentication.

--username -u

For Basic Authentication, username used for proxy authentication.

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 sphere device network proxy delete

Delete proxy connection on the attached device.

az sphere device network proxy delete [--device]

Examples

Delete proxy connection on the attached device.

az sphere device network proxy delete

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Value from: az sphere device list-attached
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 sphere device network proxy disable

Disable network proxy on the attached device.

az sphere device network proxy disable [--device]

Examples

Disable network proxy on the attached device.

az sphere device network proxy disable

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of the device.

Value from: az sphere device list-attached
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 sphere device network proxy enable

Enable network proxy on the attached device.

az sphere device network proxy enable [--device]

Examples

Enable network proxy on the attached device.

az sphere device network proxy enable

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of the device.

Value from: az sphere device list-attached
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 sphere device network proxy show

Show proxy connection on the attached device.

az sphere device network proxy show [--device]

Examples

Show proxy connection on the attached device.

az sphere device network proxy show --device <DeviceIdValue>

Optional Parameters

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Value from: az sphere device list-attached
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.