Share via

az sphere hardware-definition

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

Manage hardware definitions.

Commands

Name Description Type Status
az sphere hardware-definition generate-header

Generate a C header file corresponding to a hardware definition and place it in the folder 'inc/hw' relative to the input JSON.

 Extension GA
az sphere hardware-definition test-header

Test that the C header file in the 'inc/hw' folder is up-to-date with respect to the input JSON.

 Extension GA

az sphere hardware-definition generate-header

Generate a C header file corresponding to a hardware definition and place it in the folder 'inc/hw' relative to the input JSON.

az sphere hardware-definition generate-header --hardware-definition-file

Examples

Generate a C header file corresponding to a hardware definition

az sphere hardware-definition generate-header --hardware-definition-file mt3620.json

Required Parameters

--hardware-definition-file

Path to a hardware definition JSON file. (Path).

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 hardware-definition test-header

Test that the C header file in the 'inc/hw' folder is up-to-date with respect to the input JSON.

az sphere hardware-definition test-header --hardware-definition-file

Examples

Test a C header file

az sphere hardware-definition test-header --hardware-definition-file mt3620.json

Required Parameters

--hardware-definition-file

Path to a hardware definition JSON file. You can provide a relative or absolute path. (Path).

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.