dataflow_profiles

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

Overview

Name	dataflow_profiles
Type	Resource
Id	azure.iotoperations.dataflow_profiles

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_resource_group

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		Get a DataflowProfileResource
list_by_resource_group	select	subscriptionId, resourceGroupName, instanceName		List DataflowProfileResource resources by InstanceResource
create_or_update	insert	subscriptionId, resourceGroupName, instanceName, dataflowProfileName, data__extendedLocation		Create a DataflowProfileResource
delete	delete	subscriptionId, resourceGroupName, instanceName, dataflowProfileName		Delete a DataflowProfileResource

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
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 DataflowProfileResource

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

list_by_resource_group

List DataflowProfileResource resources by InstanceResource

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

INSERT examples

create_or_update

Create a DataflowProfileResource

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

Manifest

# Description fields are for documentation purposes
- name: dataflow_profiles
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the dataflow_profiles resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the dataflow_profiles resource.
    - name: instanceName
      value: string
      description: Required parameter for the dataflow_profiles resource.
    - name: dataflowProfileName
      value: string
      description: Required parameter for the dataflow_profiles 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 DataflowProfileResource

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