Share via

az sphere device network

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

Provides information about the status of network interfaces on the attached device.

Commands

Name Description Type Status
az sphere device network disable

Disable a network interface on the attached device.

 Extension GA
az sphere device network enable

Enable a network interface on the attached device.

 Extension GA
az sphere device network list-firewall-rules

List firewall rules for the attached device.

 Extension GA
az sphere device network list-interfaces

List the network interfaces for the attached device.

 Extension GA
az sphere device network proxy

Manage proxy address use for network connection.

 Extension GA
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 show-diagnostics

Show diagnostics for one or all Wi-Fi networks on the attached device.

 Extension GA
az sphere device network show-status

Show the network status for the attached device.

 Extension GA
az sphere device network update-interface

Update the network interface configuration for the attached device.

 Extension GA

az sphere device network disable

Disable a network interface on the attached device.

az sphere device network disable --interface
                                 [--device]

Examples

Disable the network interface

az sphere device network disable --interface eth0

Required Parameters

--interface

The interface to disable.

value from: az sphere device network list-interfaces

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 enable

Enable a network interface on the attached device.

az sphere device network enable --interface
                                [--device]

Examples

Enable the network interface

az sphere device network enable --interface eth0

Required Parameters

--interface

The interface to enable.

value from: az sphere device network list-interfaces

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 list-firewall-rules

List firewall rules for the attached device.

az sphere device network list-firewall-rules [--device]

Examples

List all firewall rules

az sphere device network list-firewall-rules

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 list-interfaces

List the network interfaces for the attached device.

az sphere device network list-interfaces [--device]

Examples

List interfaces on the attached device

az sphere device network list-interfaces

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 show-diagnostics

Show diagnostics for one or all Wi-Fi networks on the attached device.

az sphere device network show-diagnostics [--device]
                                          [--network]

Examples

Show diagnostics for all networks

az sphere device network show-diagnostics

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
--network -n

The network for which to show diagnostics.

value from: az sphere device network list-interfaces
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 show-status

Show the network status for the attached device.

az sphere device network show-status [--device]

Examples

Show status of network on device

az sphere device network show-status

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 update-interface

Update the network interface configuration for the attached device.

az sphere device network update-interface --hardware-address
                                          --interface
                                          [--device]

Examples

Update the hardware address value for a specific network interface

az sphere device network update-interface --interface eth0 --hardware-address aa:bb:33:dd:ee:ff

Required Parameters

--hardware-address

Specify the device hardware address to be set.

--interface

The interface to update.

value from: az sphere device network list-interfaces

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.