dataflows

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

Overview

Name	dataflows
Type	Resource
Id	azure.iotoperations.dataflows

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Edge location of the resource.
properties	object	The resource-specific properties for this resource.

list_by_profile_resource

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Edge location of the resource.
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, instanceName, dataflowProfileName, dataflowName		Get a DataflowResource
list_by_profile_resource	select	subscriptionId, resourceGroupName, instanceName, dataflowProfileName		List DataflowResource resources by DataflowProfileResource
create_or_update	insert	subscriptionId, resourceGroupName, instanceName, dataflowProfileName, dataflowName, data__extendedLocation		Create a DataflowResource
delete	delete	subscriptionId, resourceGroupName, instanceName, dataflowProfileName, dataflowName		Delete a DataflowResource

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
dataflowName	string	Name of Instance dataflowProfile dataflow resource
dataflowProfileName	string	Name of Instance dataflowProfile resource
instanceName	string	Name of instance.
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.

SELECT examples

get

Get a DataflowResource

SELECT
extendedLocation,
properties
FROM azure.iotoperations.dataflows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND instanceName = '{{ instanceName }}' -- required
AND dataflowProfileName = '{{ dataflowProfileName }}' -- required
AND dataflowName = '{{ dataflowName }}' -- required
;

list_by_profile_resource

List DataflowResource resources by DataflowProfileResource

SELECT
extendedLocation,
properties
FROM azure.iotoperations.dataflows
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND instanceName = '{{ instanceName }}' -- required
AND dataflowProfileName = '{{ dataflowProfileName }}' -- required
;

INSERT examples

create_or_update

Create a DataflowResource

INSERT INTO azure.iotoperations.dataflows (
data__properties,
data__extendedLocation,
subscriptionId,
resourceGroupName,
instanceName,
dataflowProfileName,
dataflowName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ instanceName }}',
'{{ dataflowProfileName }}',
'{{ dataflowName }}'
RETURNING
extendedLocation,
properties
;

Manifest

# Description fields are for documentation purposes
- name: dataflows
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the dataflows resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the dataflows resource.
    - name: instanceName
      value: string
      description: Required parameter for the dataflows resource.
    - name: dataflowProfileName
      value: string
      description: Required parameter for the dataflows resource.
    - name: dataflowName
      value: string
      description: Required parameter for the dataflows resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: extendedLocation
      value: object
      description: |
        Edge location of the resource.

DELETE examples

delete

Delete a DataflowResource

DELETE FROM azure.iotoperations.dataflows
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND instanceName = '{{ instanceName }}' --required
AND dataflowProfileName = '{{ dataflowProfileName }}' --required
AND dataflowName = '{{ dataflowName }}' --required
;