summaries

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

Overview

Name	summaries
Type	Resource
Id	azure_extras.iot_firmware_defense.summaries

Fields

The following fields are returned by SELECT queries:

get

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.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Extracting", and "Analyzing". (Succeeded, Failed, Canceled, Pending, Extracting, Analyzing)
summaryType	string	The type of summary. Required. Known values are: "Firmware", "CommonVulnerabilitiesAndExposures", "BinaryHardening", "CryptoCertificate", and "CryptoKey".
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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Extracting", and "Analyzing". (Succeeded, Failed, Canceled, Pending, Extracting, Analyzing)
summaryType	string	The type of summary. Required. Known values are: "Firmware", "CommonVulnerabilitiesAndExposures", "BinaryHardening", "CryptoCertificate", and "CryptoKey".
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	resource_group_name, workspace_name, firmware_id, summary_type, subscription_id		Get an analysis result summary of a firmware by name.
list_by_firmware	select	resource_group_name, workspace_name, firmware_id, subscription_id		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
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
summary_type	string	The Firmware analysis summary name describing the type of summary. Known values are: "Firmware", "CommonVulnerabilitiesAndExposures", "BinaryHardening", "CryptoCertificate", and "CryptoKey". Required.
workspace_name	string	The name of the firmware analysis workspace. Required.

SELECT examples

get

Get an analysis result summary of a firmware by name.

SELECT
id,
name,
provisioningState,
summaryType,
systemData,
type
FROM azure_extras.iot_firmware_defense.summaries
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND firmware_id = '{{ firmware_id }}' -- required
AND summary_type = '{{ summary_type }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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,
provisioningState,
summaryType,
systemData,
type
FROM azure_extras.iot_firmware_defense.summaries
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
;