Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Manage certificates on the attached device.
| Operation | Description |
|---|---|
| az sphere device certificate add | Add a certificate in the attached device's certificate store. |
| az sphere device certificate delete | Delete a certificate in the attached device's certificate store. |
| az sphere device certificate list | List certificates in the attached device's certificate store. |
| az sphere device certificate show-quota | Show the available free space in the attached device's certificate store. |
| az sphere device certificate show | Show details of a certificate in the attached device's certificate store. |
Commands
az sphere device certificate add
Add a certificate in the attached device's certificate store.
Required Parameters
| Parameter | Description |
|---|---|
| --certificate -c | The name of the certificate to add. |
| --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.' |
| --public-key-file -p | The path to a public key certificate .pem file. You can provide a relative or absolute path. |
Optional Parameters
| Parameter | Description |
|---|---|
| --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. Values 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. |
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
az sphere device certificate delete
Delete a certificate in the attached device's certificate store.
Required Parameters
| Parameter | Description |
|---|---|
| --certificate -c | The name of the certificate to delete. Values from: az sphere device certificate list. |
Optional Parameters
| Parameter | Description |
|---|---|
| --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. Values from: az sphere device list-attached. |
Examples
Delete a certificate on the attached device.
az sphere device certificate delete --certificate certSample
az sphere device certificate list
List certificates in the attached device's certificate store.
Optional Parameters
| Parameter | Description |
|---|---|
| --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. Values from: az sphere device list-attached. |
Examples
List certificates on the attached device.
az sphere device certificate list
az sphere device certificate show-quota
Show the available free space in the attached device's certificate store.
Optional Parameters
| Parameter | Description |
|---|---|
| --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. Values from: az sphere device list-attached. |
Examples
Show the available free space in the attached device's certificate store.
az sphere device certificate show-quota
az sphere device certificate show
Show details of a certificate in the attached device's certificate store.
Required Parameters
| Parameter | Description |
|---|---|
| --certificate -c | The certificate name of the certificate for which to show the details. Values from: az sphere device certificate list. |
Optional Parameters
| Parameter | Description |
|---|---|
| --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. Values from: az sphere device list-attached. |
Examples
Show details of a certificate on the attached device.
az sphere device certificate show --certificate certSample