crypto_certificates

Creates, updates, deletes, gets or lists a crypto_certificates resource.

Overview

Name	crypto_certificates
Type	Resource
Id	azure_extras.iot_firmware_defense.crypto_certificates

Fields

The following fields are returned by SELECT queries:

list_by_firmware

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
certificateKeyAlgorithm	string	Key algorithm used in the certificate.
certificateKeySize	integer	Size of the certificate's key in bits.
certificateName	string	Name of the certificate.
certificateRole	string	Role of the certificate (Root CA, etc).
certificateUsage	array	List of functions the certificate can fulfill.
cryptoCertId	string	ID for the certificate result.
encoding	string	Encoding used for the certificate.
expirationDate	string (date-time)	Expiration date for the certificate.
filePaths	array	List of files where this certificate was found.
fingerprint	string	Fingerprint of the certificate.
isExpired	boolean	Indicates if the certificate is expired.
isSelfSigned	boolean	Indicates if the certificate is self-signed.
isShortKeySize	boolean	Indicates the certificate's key size is considered too small to be secure for the key algorithm according to NIST guidance.
isWeakSignature	boolean	Indicates the signature algorithm used is insecure according to NIST guidance.
issuedDate	string (date-time)	Issue date for the certificate.
issuer	object	Issuer information of the certificate.
pairedKey	object	A matching paired private key.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Extracting", and "Analyzing". (Succeeded, Failed, Canceled, Pending, Extracting, Analyzing)
serialNumber	string	Serial number of the certificate.
signatureAlgorithm	string	The signature algorithm used in the certificate.
subject	object	Subject information of the certificate.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_firmware	select	resource_group_name, workspace_name, firmware_id, subscription_id		Lists crypto certificate analysis results of a firmware.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
firmware_id	string	The id of the firmware. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the firmware analysis workspace. Required.

SELECT examples

list_by_firmware

Lists crypto certificate analysis results of a firmware.

SELECT
id,
name,
certificateKeyAlgorithm,
certificateKeySize,
certificateName,
certificateRole,
certificateUsage,
cryptoCertId,
encoding,
expirationDate,
filePaths,
fingerprint,
isExpired,
isSelfSigned,
isShortKeySize,
isWeakSignature,
issuedDate,
issuer,
pairedKey,
provisioningState,
serialNumber,
signatureAlgorithm,
subject,
systemData,
type
FROM azure_extras.iot_firmware_defense.crypto_certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND firmware_id = '{{ firmware_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;