dataflow

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

Overview

Name	dataflow
Type	Resource
Id	azure.iot_operations.dataflow

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
extendedLocation	object	Edge location of the resource.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
mode	string	Mode for Dataflow. Optional; defaults to Enabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
operations	array	List of operations including source and destination references as well as transformation. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
requestDiskPersistence	string	Disk persistence mode. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
status	object	The status for the dataflow.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
extendedLocation	object	Edge location of the resource.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
mode	string	Mode for Dataflow. Optional; defaults to Enabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
operations	array	List of operations including source and destination references as well as transformation. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
requestDiskPersistence	string	Disk persistence mode. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
status	object	The status for the dataflow.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, instance_name, dataflow_profile_name, dataflow_name, subscription_id		Get a DataflowResource.
list_by_resource_group	select	resource_group_name, instance_name, dataflow_profile_name, subscription_id		List DataflowResource resources by DataflowProfileResource.
create_or_update	insert	resource_group_name, instance_name, dataflow_profile_name, dataflow_name, subscription_id		Create a DataflowResource.
create_or_update	replace	resource_group_name, instance_name, dataflow_profile_name, dataflow_name, subscription_id		Create a DataflowResource.
delete	delete	resource_group_name, instance_name, dataflow_profile_name, dataflow_name, subscription_id		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
dataflow_name	string	Name of Instance dataflowProfile dataflow resource. Required.
dataflow_profile_name	string	Name of Instance dataflowProfile resource. Required.
instance_name	string	Name of instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a DataflowResource.

SELECT
id,
name,
extendedLocation,
healthState,
mode,
operations,
provisioningState,
requestDiskPersistence,
status,
systemData,
type
FROM azure.iot_operations.dataflow
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND dataflow_profile_name = '{{ dataflow_profile_name }}' -- required
AND dataflow_name = '{{ dataflow_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List DataflowResource resources by DataflowProfileResource.

SELECT
id,
name,
extendedLocation,
healthState,
mode,
operations,
provisioningState,
requestDiskPersistence,
status,
systemData,
type
FROM azure.iot_operations.dataflow
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND dataflow_profile_name = '{{ dataflow_profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a DataflowResource.

INSERT INTO azure.iot_operations.dataflow (
properties,
extendedLocation,
resource_group_name,
instance_name,
dataflow_profile_name,
dataflow_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ instance_name }}',
'{{ dataflow_profile_name }}',
'{{ dataflow_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: dataflow
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dataflow resource.
  - name: instance_name
    value: "{{ instance_name }}"
    description: Required parameter for the dataflow resource.
  - name: dataflow_profile_name
    value: "{{ dataflow_profile_name }}"
    description: Required parameter for the dataflow resource.
  - name: dataflow_name
    value: "{{ dataflow_name }}"
    description: Required parameter for the dataflow resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dataflow resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      mode: "{{ mode }}"
      requestDiskPersistence: "{{ requestDiskPersistence }}"
      operations:
        - operationType: "{{ operationType }}"
          name: "{{ name }}"
          sourceSettings:
            endpointRef: "{{ endpointRef }}"
            assetRef: "{{ assetRef }}"
            serializationFormat: "{{ serializationFormat }}"
            schemaRef: "{{ schemaRef }}"
            dataSources:
              - "{{ dataSources }}"
          builtInTransformationSettings:
            serializationFormat: "{{ serializationFormat }}"
            schemaRef: "{{ schemaRef }}"
            datasets:
              - key: "{{ key }}"
                description: "{{ description }}"
                schemaRef: "{{ schemaRef }}"
                inputs: "{{ inputs }}"
                expression: "{{ expression }}"
            filter:
              - type: "{{ type }}"
                description: "{{ description }}"
                inputs: "{{ inputs }}"
                expression: "{{ expression }}"
            map:
              - type: "{{ type }}"
                description: "{{ description }}"
                inputs: "{{ inputs }}"
                expression: "{{ expression }}"
                output: "{{ output }}"
          destinationSettings:
            endpointRef: "{{ endpointRef }}"
            dataDestination: "{{ dataDestination }}"
            headers:
              - actionType: "{{ actionType }}"
      provisioningState: "{{ provisioningState }}"
      status:
        healthState:
          status: "{{ status }}"
          lastTransitionTime: "{{ lastTransitionTime }}"
          lastUpdateTime: "{{ lastUpdateTime }}"
          message: "{{ message }}"
          reasonCode: "{{ reasonCode }}"
      healthState: "{{ healthState }}"
  - name: extendedLocation
    description: |
      Edge location of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

REPLACE examples

create_or_update

Create a DataflowResource.

REPLACE azure.iot_operations.dataflow
SET 
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND instance_name = '{{ instance_name }}' --required
AND dataflow_profile_name = '{{ dataflow_profile_name }}' --required
AND dataflow_name = '{{ dataflow_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type;

DELETE examples

delete

Delete a DataflowResource.

DELETE FROM azure.iot_operations.dataflow
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND instance_name = '{{ instance_name }}' --required
AND dataflow_profile_name = '{{ dataflow_profile_name }}' --required
AND dataflow_name = '{{ dataflow_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;