sbom_components

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

Overview

Name	sbom_components
Type	Resource
Id	azure_extras.iot_firmware_defense.sbom_components

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.
componentId	string	ID for the component.
componentName	string	Name for the component.
filePaths	array	File paths related to the component. Note, relatedFiles should be used instead of this property.
license	string	License for the component.
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".
version	string	Version for the component.

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

SELECT
id,
name,
componentId,
componentName,
filePaths,
license,
provisioningState,
systemData,
type,
version
FROM azure_extras.iot_firmware_defense.sbom_components
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
;