summaries

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

Overview

Name	summaries
Type	Resource
Id	azure.iot_firmware_defense.summaries

Fields

The following fields are returned by SELECT queries:

get

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	Properties of an analysis summary.
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"

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	Properties of an analysis summary.
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
get	select	subscriptionId, resourceGroupName, workspaceName, firmwareId, summaryName		Get an analysis result summary of a firmware by name.
list_by_firmware	select	subscriptionId, resourceGroupName, workspaceName, firmwareId		Lists analysis result summary names of a firmware. To fetch the full summary data, get that summary by name.

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.
summaryName	string	The Firmware analysis summary name describing the type of summary.
workspaceName	string	The name of the firmware analysis workspace.

SELECT examples

get

Get an analysis result summary of a firmware by name.

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

list_by_firmware

Lists analysis result summary names of a firmware. To fetch the full summary data, get that summary by name.

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