workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure.iot_firmware_defense.workspaces

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Workspace properties.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Workspace properties.
tags	object	Resource tags.

list_by_subscription

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Workspace properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName		Get firmware analysis workspace.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all of the firmware analysis workspaces in the specified resource group.
list_by_subscription	select	subscriptionId		Lists all of the firmware analysis workspaces in the specified subscription.
create	insert	subscriptionId, resourceGroupName, workspaceName		The operation to create or update a firmware analysis workspace.
update	update	subscriptionId, resourceGroupName, workspaceName		The operation to update a firmware analysis workspaces.
delete	delete	subscriptionId, resourceGroupName, workspaceName		The operation to delete a firmware analysis workspace.
generate_upload_url	exec	subscriptionId, resourceGroupName, workspaceName		The operation to get a url for file upload.

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
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 analysis workspace.

SELECT
location,
properties,
tags
FROM azure.iot_firmware_defense.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

list_by_resource_group

Lists all of the firmware analysis workspaces in the specified resource group.

SELECT
location,
properties,
tags
FROM azure.iot_firmware_defense.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists all of the firmware analysis workspaces in the specified subscription.

SELECT
location,
properties,
tags
FROM azure.iot_firmware_defense.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

The operation to create or update a firmware analysis workspace.

INSERT INTO azure.iot_firmware_defense.workspaces (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
workspaceName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: workspaces
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the workspaces resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspaces resource.
    - name: workspaceName
      value: string
      description: Required parameter for the workspaces resource.
    - name: properties
      value: object
      description: |
        Workspace properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

The operation to update a firmware analysis workspaces.

UPDATE azure.iot_firmware_defense.workspaces
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

The operation to delete a firmware analysis workspace.

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

Lifecycle Methods

generate_upload_url

The operation to get a url for file upload.

EXEC azure.iot_firmware_defense.workspaces.generate_upload_url 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required 
@@json=
'{
"firmwareId": "{{ firmwareId }}"
}'
;