dataflow_endpoints

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

Overview

Name	dataflow_endpoints
Type	Resource
Id	azure.iotoperations.dataflow_endpoints

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

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
dataflowEndpointName	string	Name of Instance dataflowEndpoint 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 DataflowEndpointResource

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

list_by_resource_group

List DataflowEndpointResource resources by InstanceResource

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

INSERT examples

create_or_update

Create a DataflowEndpointResource

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

Manifest

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

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