firmwares

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

Overview

Name	firmwares
Type	Resource
Id	azure.iot_firmware_defense.firmwares

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	The properties of a firmware (title: Firmware 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"

list_by_workspace

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 a firmware (title: Firmware 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
get	select	subscriptionId, resourceGroupName, workspaceName, firmwareId		Get firmware.
list_by_workspace	select	subscriptionId, resourceGroupName, workspaceName		Lists all of firmwares inside a workspace.
create	insert	subscriptionId, resourceGroupName, workspaceName, firmwareId		The operation to create a firmware.
update	update	subscriptionId, resourceGroupName, workspaceName, firmwareId		The operation to update firmware.
delete	delete	subscriptionId, resourceGroupName, workspaceName, firmwareId		The operation to delete a firmware.
generate_download_url	exec	subscriptionId, resourceGroupName, workspaceName, firmwareId		The operation to a url for file download.
generate_filesystem_download_url	exec	subscriptionId, resourceGroupName, workspaceName, firmwareId		The operation to a url for tar file download.

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

get

Get firmware.

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

list_by_workspace

Lists all of firmwares inside a workspace.

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

INSERT examples

create

The operation to create a firmware.

INSERT INTO azure.iot_firmware_defense.firmwares (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
firmwareId
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ firmwareId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: firmwares
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the firmwares resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the firmwares resource.
    - name: workspaceName
      value: string
      description: Required parameter for the firmwares resource.
    - name: firmwareId
      value: string
      description: Required parameter for the firmwares resource.
    - name: properties
      value: object
      description: |
        The properties of a firmware

UPDATE examples

update

The operation to update firmware.

UPDATE azure.iot_firmware_defense.firmwares
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND firmwareId = '{{ firmwareId }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

The operation to delete a firmware.

DELETE FROM azure.iot_firmware_defense.firmwares
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND firmwareId = '{{ firmwareId }}' --required
;

Lifecycle Methods

generate_download_url

The operation to a url for file download.

EXEC azure.iot_firmware_defense.firmwares.generate_download_url 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@firmwareId='{{ firmwareId }}' --required
;

generate_filesystem_download_url

The operation to a url for tar file download.

EXEC azure.iot_firmware_defense.firmwares.generate_filesystem_download_url 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@firmwareId='{{ firmwareId }}' --required
;