firmwares

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

Overview

Name	firmwares
Type	Resource
Id	azure.iot_firmware_defense.firmwares

Fields

vw_firmwares

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	text	The name of the resource
description	text	field from the properties object
file_name	text	field from the properties object
file_size	text	field from the properties object
firmwareId	text	field from the properties object
model	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
status	text	field from the properties object
status_messages	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vendor	text	field from the properties object
version	text	field from the properties object
workspaceName	text	field from the properties object

firmwares

Name	Datatype	Description
id	string	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	Firmware properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	firmwareId, resourceGroupName, subscriptionId, workspaceName	Get firmware.
list_by_workspace	SELECT	resourceGroupName, subscriptionId, workspaceName	Lists all of firmwares inside a workspace.
create	INSERT	firmwareId, resourceGroupName, subscriptionId, workspaceName	The operation to create a firmware.
delete	DELETE	firmwareId, resourceGroupName, subscriptionId, workspaceName	The operation to delete a firmware.
update	UPDATE	firmwareId, resourceGroupName, subscriptionId, workspaceName	The operation to update firmware.
generate_download_url	EXEC	firmwareId, resourceGroupName, subscriptionId, workspaceName	The operation to a url for file download.
generate_filesystem_download_url	EXEC	firmwareId, resourceGroupName, subscriptionId, workspaceName	The operation to a url for tar file download.

SELECT examples

Lists all of firmwares inside a workspace.

vw_firmwares

SELECT
id,
name,
description,
file_name,
file_size,
firmwareId,
model,
provisioning_state,
resourceGroupName,
status,
status_messages,
subscriptionId,
system_data,
type,
vendor,
version,
workspaceName
FROM azure.iot_firmware_defense.vw_firmwares
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

firmwares

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

INSERT example

Use the following StackQL query and manifest file to create a new firmwares resource.

All Properties

/*+ create */
INSERT INTO azure.iot_firmware_defense.firmwares (
firmwareId,
resourceGroupName,
subscriptionId,
workspaceName,
properties
)
SELECT 
'{{ firmwareId }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: fileName
          value: string
        - name: vendor
          value: string
        - name: model
          value: string
        - name: version
          value: string
        - name: description
          value: string
        - name: fileSize
          value: integer
        - name: status
          value: string
        - name: statusMessages
          value:
            - - name: errorCode
                value: integer
              - name: message
                value: string
        - name: provisioningState
          value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a firmwares resource.

/*+ update */
UPDATE azure.iot_firmware_defense.firmwares
SET 
properties = '{{ properties }}'
WHERE 
firmwareId = '{{ firmwareId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

DELETE example

Deletes the specified firmwares resource.

/*+ delete */
DELETE FROM azure.iot_firmware_defense.firmwares
WHERE firmwareId = '{{ firmwareId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';