firmwares

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

Overview

Name	firmwares
Type	Resource
Id	azure_extras.iot_firmware_defense.firmwares

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.
description	string	User-specified description of the firmware.
fileName	string	File name for a firmware that user uploaded.
fileSize	integer	File size of the uploaded firmware image.
model	string	Firmware model.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Extracting", and "Analyzing". (Succeeded, Failed, Canceled, Pending, Extracting, Analyzing)
status	string	The status of firmware scan. Known values are: "Pending", "Extracting", "Analyzing", "Ready", and "Error". (Pending, Extracting, Analyzing, Ready, Error)
statusMessages	array	A list of errors or other messages generated during firmware analysis.
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".
vendor	string	Firmware vendor.
version	string	Firmware version.

list_by_workspace

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.
description	string	User-specified description of the firmware.
fileName	string	File name for a firmware that user uploaded.
fileSize	integer	File size of the uploaded firmware image.
model	string	Firmware model.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Extracting", and "Analyzing". (Succeeded, Failed, Canceled, Pending, Extracting, Analyzing)
status	string	The status of firmware scan. Known values are: "Pending", "Extracting", "Analyzing", "Ready", and "Error". (Pending, Extracting, Analyzing, Ready, Error)
statusMessages	array	A list of errors or other messages generated during firmware analysis.
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".
vendor	string	Firmware vendor.
version	string	Firmware version.

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, subscription_id		Get firmware.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		Lists all of firmwares inside a workspace.
create	insert	resource_group_name, workspace_name, firmware_id, subscription_id		The operation to create a firmware.
update	update	resource_group_name, workspace_name, firmware_id, subscription_id		The operation to update firmware.
delete	delete	resource_group_name, workspace_name, firmware_id, subscription_id		The operation to delete 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

get

Get firmware.

SELECT
id,
name,
description,
fileName,
fileSize,
model,
provisioningState,
status,
statusMessages,
systemData,
type,
vendor,
version
FROM azure_extras.iot_firmware_defense.firmwares
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
;

list_by_workspace

Lists all of firmwares inside a workspace.

SELECT
id,
name,
description,
fileName,
fileSize,
model,
provisioningState,
status,
statusMessages,
systemData,
type,
vendor,
version
FROM azure_extras.iot_firmware_defense.firmwares
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

The operation to create a firmware.

INSERT INTO azure_extras.iot_firmware_defense.firmwares (
properties,
resource_group_name,
workspace_name,
firmware_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ firmware_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: firmwares
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the firmwares resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the firmwares resource.
  - name: firmware_id
    value: "{{ firmware_id }}"
    description: Required parameter for the firmwares resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the firmwares resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      fileName: "{{ fileName }}"
      vendor: "{{ vendor }}"
      model: "{{ model }}"
      version: "{{ version }}"
      description: "{{ description }}"
      fileSize: {{ fileSize }}
      status: "{{ status }}"
      statusMessages:
        - errorCode: {{ errorCode }}
          message: "{{ message }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

The operation to update firmware.

UPDATE azure_extras.iot_firmware_defense.firmwares
SET 
properties = '{{ properties }}'
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
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

The operation to delete a firmware.

DELETE FROM azure_extras.iot_firmware_defense.firmwares
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
;