dataflow_endpoints

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

Overview

Name	dataflow_endpoints
Type	Resource
Id	azure.iotoperations.dataflow_endpoints

Fields

vw_dataflow_endpoints

Name	Datatype	Description
data_explorer_settings	text	field from the properties object
data_lake_storage_settings	text	field from the properties object
dataflowEndpointName	text	field from the properties object
endpoint_type	text	field from the properties object
extended_location	text	field from the properties object
fabric_one_lake_settings	text	field from the properties object
instanceName	text	field from the properties object
kafka_settings	text	field from the properties object
local_storage_settings	text	field from the properties object
mqtt_settings	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object

dataflow_endpoints

Name	Datatype	Description
extendedLocation	object	Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.
properties	object	DataflowEndpoint Resource properties. NOTE - Only one type of endpoint is supported for one Resource

Methods

Name	Accessible by	Required Params	Description
get	SELECT	dataflowEndpointName, instanceName, resourceGroupName, subscriptionId	Get a DataflowEndpointResource
list_by_resource_group	SELECT	instanceName, resourceGroupName, subscriptionId	List DataflowEndpointResource resources by InstanceResource
create_or_update	INSERT	dataflowEndpointName, instanceName, resourceGroupName, subscriptionId, data__extendedLocation	Create a DataflowEndpointResource
delete	DELETE	dataflowEndpointName, instanceName, resourceGroupName, subscriptionId	Delete a DataflowEndpointResource

SELECT examples

List DataflowEndpointResource resources by InstanceResource

vw_dataflow_endpoints

SELECT
data_explorer_settings,
data_lake_storage_settings,
dataflowEndpointName,
endpoint_type,
extended_location,
fabric_one_lake_settings,
instanceName,
kafka_settings,
local_storage_settings,
mqtt_settings,
provisioning_state,
resourceGroupName,
subscriptionId
FROM azure.iotoperations.vw_dataflow_endpoints
WHERE instanceName = '{{ instanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

dataflow_endpoints

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

INSERT example

Use the following StackQL query and manifest file to create a new dataflow_endpoints resource.

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: endpointType
          value: []
        - name: dataExplorerSettings
          value:
            - name: authentication
              value:
                - name: method
                  value: []
                - name: systemAssignedManagedIdentitySettings
                  value:
                    - name: audience
                      value: string
                - name: userAssignedManagedIdentitySettings
                  value:
                    - name: clientId
                      value: string
                    - name: scope
                      value: string
                    - name: tenantId
                      value: string
            - name: database
              value: string
            - name: host
              value: string
            - name: batching
              value:
                - name: latencySeconds
                  value: integer
                - name: maxMessages
                  value: integer
        - name: dataLakeStorageSettings
          value:
            - name: authentication
              value:
                - name: method
                  value: []
                - name: accessTokenSettings
                  value:
                    - name: secretRef
                      value: string
            - name: host
              value: string
        - name: fabricOneLakeSettings
          value:
            - name: authentication
              value:
                - name: method
                  value: []
            - name: names
              value:
                - name: lakehouseName
                  value: string
                - name: workspaceName
                  value: string
            - name: oneLakePathType
              value: []
            - name: host
              value: string
        - name: kafkaSettings
          value:
            - name: authentication
              value:
                - name: method
                  value: []
                - name: saslSettings
                  value:
                    - name: saslType
                      value: []
                    - name: secretRef
                      value: string
                - name: x509CertificateSettings
                  value:
                    - name: secretRef
                      value: string
            - name: consumerGroupId
              value: string
            - name: host
              value: string
            - name: batching
              value:
                - name: mode
                  value: string
                - name: latencyMs
                  value: integer
                - name: maxBytes
                  value: integer
                - name: maxMessages
                  value: integer
            - name: copyMqttProperties
              value: string
            - name: compression
              value: string
            - name: kafkaAcks
              value: string
            - name: partitionStrategy
              value: string
            - name: tls
              value:
                - name: mode
                  value: string
                - name: trustedCaCertificateConfigMapRef
                  value: string
            - name: cloudEventAttributes
              value: []
        - name: localStorageSettings
          value:
            - name: persistentVolumeClaimRef
              value: string
        - name: mqttSettings
          value:
            - name: authentication
              value:
                - name: method
                  value: []
                - name: serviceAccountTokenSettings
                  value:
                    - name: audience
                      value: string
            - name: clientIdPrefix
              value: string
            - name: host
              value: string
            - name: protocol
              value: string
            - name: keepAliveSeconds
              value: integer
            - name: retain
              value: string
            - name: maxInflightMessages
              value: integer
            - name: qos
              value: integer
            - name: sessionExpirySeconds
              value: integer
        - name: provisioningState
          value: []
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: []

DELETE example

Deletes the specified dataflow_endpoints resource.

/*+ delete */
DELETE FROM azure.iotoperations.dataflow_endpoints
WHERE dataflowEndpointName = '{{ dataflowEndpointName }}'
AND instanceName = '{{ instanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';