datasets
Creates, updates, deletes, gets or lists a datasets
resource.
Overview
Name | datasets |
Type | Resource |
Id | azure.iot_data_processor.datasets |
Fields
The following fields are returned by SELECT
queries:
- get
Azure operation completed successfully.
Name | Datatype | Description |
---|---|---|
extendedLocation | object | Edge location of the resource. |
location | string | The geo-location where the resource lives |
properties | object | The resource-specific properties for this resource. |
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 , instanceName , datasetName | Get a Dataset | |
create_or_update | insert | subscriptionId , resourceGroupName , instanceName , datasetName , data__extendedLocation | Create a Dataset | |
update | update | subscriptionId , resourceGroupName , instanceName , datasetName | Update a Dataset | |
delete | delete | subscriptionId , resourceGroupName , instanceName , datasetName | Delete a Dataset |
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 |
---|---|---|
datasetName | string | Name of dataset. |
instanceName | string | Name of instance. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string | The ID of the target subscription. |
SELECT
examples
- get
Get a Dataset
SELECT
extendedLocation,
location,
properties,
tags
FROM azure.iot_data_processor.datasets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND instanceName = '{{ instanceName }}' -- required
AND datasetName = '{{ datasetName }}' -- required
;
INSERT
examples
- create_or_update
- Manifest
Create a Dataset
INSERT INTO azure.iot_data_processor.datasets (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
instanceName,
datasetName
)
SELECT
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ instanceName }}',
'{{ datasetName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;
# Description fields are for documentation purposes
- name: datasets
props:
- name: subscriptionId
value: string
description: Required parameter for the datasets resource.
- name: resourceGroupName
value: string
description: Required parameter for the datasets resource.
- name: instanceName
value: string
description: Required parameter for the datasets resource.
- name: datasetName
value: string
description: Required parameter for the datasets resource.
- name: properties
value: object
description: |
The resource-specific properties for this resource.
- name: extendedLocation
value: object
description: |
Edge location of the resource.
- name: tags
value: object
description: |
Resource tags.
- name: location
value: string
description: |
The geo-location where the resource lives
UPDATE
examples
- update
Update a Dataset
UPDATE azure.iot_data_processor.datasets
SET
data__tags = '{{ tags }}'
WHERE
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND instanceName = '{{ instanceName }}' --required
AND datasetName = '{{ datasetName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;
DELETE
examples
- delete
Delete a Dataset
DELETE FROM azure.iot_data_processor.datasets
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND instanceName = '{{ instanceName }}' --required
AND datasetName = '{{ datasetName }}' --required
;