devices

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

Overview

Name	devices
Type	Resource
Id	azure_extras.agrifood_farming.devices

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_or_update	insert	sensor_partner_id, device_id, endpoint		Create a device entity.
create_or_update	replace	sensor_partner_id, device_id, endpoint		Create a device entity.
delete	delete	sensor_partner_id, device_id, endpoint		Deletes a device entity.
get_raw	exec	sensor_partner_id, device_id, endpoint		Gets a device entity.
list_raw	exec	sensor_partner_id, endpoint	minCreatedDateTime, maxCreatedDateTime, minLastModifiedDateTime, maxLastModifiedDateTime, skipToken	Returns a paginated list of device resources.

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
device_id	string	Id of the device resource. Required.
endpoint	string	The service endpoint host (no scheme). (default: )
sensor_partner_id	string	Id of the associated sensor partner. Required.
maxCreatedDateTime	string (date-time)	Maximum creation date of resource (inclusive). Default value is None.
maxLastModifiedDateTime	string (date-time)	Maximum last modified date of resource (inclusive). Default value is None.
minCreatedDateTime	string (date-time)	Minimum creation date of resource (inclusive). Default value is None.
minLastModifiedDateTime	string (date-time)	Minimum last modified date of resource (inclusive). Default value is None.
skipToken	string	Skip token for getting next set of results. Default value is None.

INSERT examples

create_or_update

Create a device entity.

INSERT INTO azure_extras.agrifood_farming.devices (
sensor_partner_id,
device_id,
endpoint
)
SELECT 
'{{ sensor_partner_id }}',
'{{ device_id }}',
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: devices
props:
  - name: sensor_partner_id
    value: "{{ sensor_partner_id }}"
    description: Required parameter for the devices resource.
  - name: device_id
    value: "{{ device_id }}"
    description: Required parameter for the devices resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the devices resource.

REPLACE examples

create_or_update

Create a device entity.

REPLACE azure_extras.agrifood_farming.devices
SET 
-- No updatable properties
WHERE 
sensor_partner_id = '{{ sensor_partner_id }}' --required
AND device_id = '{{ device_id }}' --required
AND endpoint = '{{ endpoint }}' --required;

DELETE examples

delete

Deletes a device entity.

DELETE FROM azure_extras.agrifood_farming.devices
WHERE sensor_partner_id = '{{ sensor_partner_id }}' --required
AND device_id = '{{ device_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_raw

Gets a device entity.

EXEC azure_extras.agrifood_farming.devices.get_raw 
@sensor_partner_id='{{ sensor_partner_id }}' --required, 
@device_id='{{ device_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

list_raw

Returns a paginated list of device resources.

EXEC azure_extras.agrifood_farming.devices.list_raw 
@sensor_partner_id='{{ sensor_partner_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@minCreatedDateTime='{{ minCreatedDateTime }}', 
@maxCreatedDateTime='{{ maxCreatedDateTime }}', 
@minLastModifiedDateTime='{{ minLastModifiedDateTime }}', 
@maxLastModifiedDateTime='{{ maxLastModifiedDateTime }}', 
@skipToken='{{ skipToken }}'
;