az sphere device certificate

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

Manage certificates on the attached device.

Commands

Name	Description	Type	Status
az sphere device certificate add	Add a certificate in the attached device's certificate store.	Extension	GA
az sphere device certificate delete	Delete a certificate in the attached device's certificate store.	Extension	GA
az sphere device certificate list	List certificates in the attached device's certificate store.	Extension	GA
az sphere device certificate show	Show details of a certificate in the attached device's certificate store.	Extension	GA
az sphere device certificate show-quota	Show the available free space in the attached device's certificate store.	Extension	GA

az sphere device certificate add

Add a certificate in the attached device's certificate store.

az sphere device certificate add --cert-type {client, rootca}
                                 --certificate
                                 --public-key-file
                                 [--device]
                                 [--private-key-file]
                                 [--private-key-password]

Examples

Add a rootca certificate on the attached device.

az sphere device certificate add --certificate certSample --cert-type rootca --public-key-file pubcert.pem

Add a client certificate on the attached device.

az sphere device certificate add --certificate certSample --cert-type client --public-key-file pubcert.pem --private-key-file privkeycert.pem --private-key-password 1234

Required Parameters

--cert-type -t

The type of certificate to add. "rootca" - a root CA certificate for use with EAP-TLS networks where the device authenticates the server. "client" - a client certificate, containing both the public and private key, for use with EAP-TLS networks. Please see: https://aka.ms/AzureSphereCertificateStore for more details.

Accepted values: client, rootca

--certificate -c

The name of the certificate to add.

--public-key-file -p

The path to a public key certificate .pem file. You can provide a relative or absolute path.

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

--private-key-file

The path to a client private key .pem file. Required when adding a certificate of type "client". You can provide a relative or absolute path.

--private-key-password -w

Password for the client private key. Required when adding a client private key that is encrypted.

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 certificate delete

Delete a certificate in the attached device's certificate store.

az sphere device certificate delete --certificate
                                    [--device]

Examples

Delete a certificate on the attached device.

az sphere device certificate delete --certificate certSample

Required Parameters

--certificate -c

The name of the certificate to delete.

Value from: az sphere device certificate list

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

List certificates in the attached device's certificate store.

az sphere device certificate list [--device]

Examples

List certificates on the attached device.

az sphere device certificate list

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

Show details of a certificate in the attached device's certificate store.

az sphere device certificate show --certificate
                                  [--device]

Examples

Show details of a certificate on the attached device.

az sphere device certificate show --certificate certSample

Required Parameters

--certificate -c

The certificate name of the certificate for which to show the details.

Value from: az sphere device certificate list

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 certificate show-quota

Show the available free space in the attached device's certificate store.

az sphere device certificate show-quota [--device]

Examples

Show the available free space in the attached device's certificate store.

az sphere device certificate show-quota

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.