crypto_keys

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

Overview

Name	crypto_keys
Type	Resource
Id	azure_extras.iot_firmware_defense.crypto_keys

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.
cryptoKeyId	string	ID for the key result.
cryptoKeySize	integer	Size of the key in bits.
filePaths	array	List of files where this key was found.
isShortKeySize	boolean	Indicates the key size is considered too small to be secure for the algorithm according to NIST guidance.
keyAlgorithm	string	Key algorithm name.
keyType	string	Type of the key (public or private). Known values are: "Public" and "Private". (Public, Private)
pairedKey	object	A matching paired key or certificate.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Extracting", and "Analyzing". (Succeeded, Failed, Canceled, Pending, Extracting, Analyzing)
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".
usage	array	Functions the key can fulfill.

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 key 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 key analysis results of a firmware.

SELECT
id,
name,
cryptoKeyId,
cryptoKeySize,
filePaths,
isShortKeySize,
keyAlgorithm,
keyType,
pairedKey,
provisioningState,
systemData,
type,
usage
FROM azure_extras.iot_firmware_defense.crypto_keys
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
;