sbom_components

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

Overview

Name	sbom_components
Type	Resource
Id	azure.iot_firmware_defense.sbom_components

Fields

The following fields are returned by SELECT queries:

list_by_firmware

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	The properties of an SBOM component found within a firmware image (title: SBOM result properties)
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	subscriptionId, resourceGroupName, workspaceName, firmwareId		Lists SBOM 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
firmwareId	string	The id of the firmware.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
workspaceName	string	The name of the firmware analysis workspace.

SELECT examples

list_by_firmware

Lists SBOM analysis results of a firmware.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.iot_firmware_defense.sbom_components
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND firmwareId = '{{ firmwareId }}' -- required
;