dataflow_endpoint

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

Overview

Name	dataflow_endpoint
Type	Resource
Id	azure.iot_operations.dataflow_endpoint

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.
dataExplorerSettings	object	Azure Data Explorer endpoint.
dataLakeStorageSettings	object	Azure Data Lake endpoint.
endpointType	string	Endpoint Type. Required. Known values are: "DataExplorer", "DataLakeStorage", "FabricOneLake", "Kafka", "LocalStorage", "Mqtt", and "OpenTelemetry". (DataExplorer, DataLakeStorage, FabricOneLake, Kafka, LocalStorage, Mqtt, OpenTelemetry)
extendedLocation	object	Edge location of the resource.
fabricOneLakeSettings	object	Microsoft Fabric endpoint.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
hostType	string	The type of the Kafka host. E.g FabricRT, EventGrid. Known values are: "FabricRT", "EventGrid", "LocalBroker", "Eventhub", "CustomMqtt", and "CustomKafka". (FabricRT, EventGrid, LocalBroker, Eventhub, CustomMqtt, CustomKafka)
kafkaSettings	object	Kafka endpoint.
localStorageSettings	object	Local persistent volume endpoint.
mqttSettings	object	Broker endpoint.
openTelemetrySettings	object	OpenTelemetry endpoint.
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)
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.
dataExplorerSettings	object	Azure Data Explorer endpoint.
dataLakeStorageSettings	object	Azure Data Lake endpoint.
endpointType	string	Endpoint Type. Required. Known values are: "DataExplorer", "DataLakeStorage", "FabricOneLake", "Kafka", "LocalStorage", "Mqtt", and "OpenTelemetry". (DataExplorer, DataLakeStorage, FabricOneLake, Kafka, LocalStorage, Mqtt, OpenTelemetry)
extendedLocation	object	Edge location of the resource.
fabricOneLakeSettings	object	Microsoft Fabric endpoint.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
hostType	string	The type of the Kafka host. E.g FabricRT, EventGrid. Known values are: "FabricRT", "EventGrid", "LocalBroker", "Eventhub", "CustomMqtt", and "CustomKafka". (FabricRT, EventGrid, LocalBroker, Eventhub, CustomMqtt, CustomKafka)
kafkaSettings	object	Kafka endpoint.
localStorageSettings	object	Local persistent volume endpoint.
mqttSettings	object	Broker endpoint.
openTelemetrySettings	object	OpenTelemetry endpoint.
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)
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_endpoint_name, subscription_id		Get a DataflowEndpointResource.
list_by_resource_group	select	resource_group_name, instance_name, subscription_id		List DataflowEndpointResource resources by InstanceResource.
create_or_update	insert	resource_group_name, instance_name, dataflow_endpoint_name, subscription_id		Create a DataflowEndpointResource.
create_or_update	replace	resource_group_name, instance_name, dataflow_endpoint_name, subscription_id		Create a DataflowEndpointResource.
delete	delete	resource_group_name, instance_name, dataflow_endpoint_name, subscription_id		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
dataflow_endpoint_name	string	Name of Instance dataflowEndpoint 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 DataflowEndpointResource.

SELECT
id,
name,
dataExplorerSettings,
dataLakeStorageSettings,
endpointType,
extendedLocation,
fabricOneLakeSettings,
healthState,
hostType,
kafkaSettings,
localStorageSettings,
mqttSettings,
openTelemetrySettings,
provisioningState,
systemData,
type
FROM azure.iot_operations.dataflow_endpoint
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND dataflow_endpoint_name = '{{ dataflow_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List DataflowEndpointResource resources by InstanceResource.

SELECT
id,
name,
dataExplorerSettings,
dataLakeStorageSettings,
endpointType,
extendedLocation,
fabricOneLakeSettings,
healthState,
hostType,
kafkaSettings,
localStorageSettings,
mqttSettings,
openTelemetrySettings,
provisioningState,
systemData,
type
FROM azure.iot_operations.dataflow_endpoint
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a DataflowEndpointResource.

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

Manifest

# Description fields are for documentation purposes
- name: dataflow_endpoint
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dataflow_endpoint resource.
  - name: instance_name
    value: "{{ instance_name }}"
    description: Required parameter for the dataflow_endpoint resource.
  - name: dataflow_endpoint_name
    value: "{{ dataflow_endpoint_name }}"
    description: Required parameter for the dataflow_endpoint resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dataflow_endpoint resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      endpointType: "{{ endpointType }}"
      hostType: "{{ hostType }}"
      dataExplorerSettings:
        authentication:
          method: "{{ method }}"
          systemAssignedManagedIdentitySettings:
            audience: "{{ audience }}"
          userAssignedManagedIdentitySettings:
            clientId: "{{ clientId }}"
            scope: "{{ scope }}"
            tenantId: "{{ tenantId }}"
        database: "{{ database }}"
        host: "{{ host }}"
        batching:
          latencySeconds: {{ latencySeconds }}
          maxMessages: {{ maxMessages }}
      dataLakeStorageSettings:
        authentication:
          method: "{{ method }}"
          accessTokenSettings:
            secretRef: "{{ secretRef }}"
          systemAssignedManagedIdentitySettings:
            audience: "{{ audience }}"
          userAssignedManagedIdentitySettings:
            clientId: "{{ clientId }}"
            scope: "{{ scope }}"
            tenantId: "{{ tenantId }}"
        host: "{{ host }}"
        batching:
          latencySeconds: {{ latencySeconds }}
          maxMessages: {{ maxMessages }}
      fabricOneLakeSettings:
        authentication:
          method: "{{ method }}"
          systemAssignedManagedIdentitySettings:
            audience: "{{ audience }}"
          userAssignedManagedIdentitySettings:
            clientId: "{{ clientId }}"
            scope: "{{ scope }}"
            tenantId: "{{ tenantId }}"
        names:
          lakehouseName: "{{ lakehouseName }}"
          workspaceName: "{{ workspaceName }}"
        oneLakePathType: "{{ oneLakePathType }}"
        host: "{{ host }}"
        batching:
          latencySeconds: {{ latencySeconds }}
          maxMessages: {{ maxMessages }}
      kafkaSettings:
        authentication:
          method: "{{ method }}"
          systemAssignedManagedIdentitySettings:
            audience: "{{ audience }}"
          userAssignedManagedIdentitySettings:
            clientId: "{{ clientId }}"
            scope: "{{ scope }}"
            tenantId: "{{ tenantId }}"
          saslSettings:
            saslType: "{{ saslType }}"
            secretRef: "{{ secretRef }}"
          x509CertificateSettings:
            secretRef: "{{ secretRef }}"
        consumerGroupId: "{{ consumerGroupId }}"
        host: "{{ host }}"
        batching:
          mode: "{{ mode }}"
          latencyMs: {{ latencyMs }}
          maxBytes: {{ maxBytes }}
          maxMessages: {{ maxMessages }}
        copyMqttProperties: "{{ copyMqttProperties }}"
        compression: "{{ compression }}"
        kafkaAcks: "{{ kafkaAcks }}"
        partitionStrategy: "{{ partitionStrategy }}"
        tls:
          mode: "{{ mode }}"
          trustedCaCertificateConfigMapRef: "{{ trustedCaCertificateConfigMapRef }}"
        cloudEventAttributes: "{{ cloudEventAttributes }}"
      localStorageSettings:
        persistentVolumeClaimRef: "{{ persistentVolumeClaimRef }}"
      mqttSettings:
        authentication:
          method: "{{ method }}"
          systemAssignedManagedIdentitySettings:
            audience: "{{ audience }}"
          userAssignedManagedIdentitySettings:
            clientId: "{{ clientId }}"
            scope: "{{ scope }}"
            tenantId: "{{ tenantId }}"
          serviceAccountTokenSettings:
            audience: "{{ audience }}"
          x509CertificateSettings:
            secretRef: "{{ secretRef }}"
        clientIdPrefix: "{{ clientIdPrefix }}"
        host: "{{ host }}"
        protocol: "{{ protocol }}"
        keepAliveSeconds: {{ keepAliveSeconds }}
        retain: "{{ retain }}"
        maxInflightMessages: {{ maxInflightMessages }}
        qos: {{ qos }}
        sessionExpirySeconds: {{ sessionExpirySeconds }}
        tls:
          mode: "{{ mode }}"
          trustedCaCertificateConfigMapRef: "{{ trustedCaCertificateConfigMapRef }}"
        cloudEventAttributes: "{{ cloudEventAttributes }}"
      openTelemetrySettings:
        host: "{{ host }}"
        batching:
          latencySeconds: {{ latencySeconds }}
          maxMessages: {{ maxMessages }}
        tls:
          mode: "{{ mode }}"
          trustedCaCertificateConfigMapRef: "{{ trustedCaCertificateConfigMapRef }}"
        authentication:
          method: "{{ method }}"
      provisioningState: "{{ provisioningState }}"
      healthState: "{{ healthState }}"
  - name: extendedLocation
    description: |
      Edge location of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

REPLACE examples

create_or_update

Create a DataflowEndpointResource.

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

DELETE examples

delete

Delete a DataflowEndpointResource.

DELETE FROM azure.iot_operations.dataflow_endpoint
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND instance_name = '{{ instance_name }}' --required
AND dataflow_endpoint_name = '{{ dataflow_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;