dataflow_profile

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

Overview

Name	dataflow_profile
Type	Resource
Id	azure.iot_operations.dataflow_profile

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.
diagnostics	object	Spec defines the desired identities of NBC diagnostics settings.
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)
instanceCount	integer	To manually scale the dataflow profile, specify the maximum number of instances you want to run.
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)
status	object	The status for the dataflow profile.
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.
diagnostics	object	Spec defines the desired identities of NBC diagnostics settings.
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)
instanceCount	integer	To manually scale the dataflow profile, specify the maximum number of instances you want to run.
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)
status	object	The status for the dataflow profile.
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, subscription_id		Get a DataflowProfileResource.
list_by_resource_group	select	resource_group_name, instance_name, subscription_id		List DataflowProfileResource resources by InstanceResource.
create_or_update	insert	resource_group_name, instance_name, dataflow_profile_name, subscription_id		Create a DataflowProfileResource.
create_or_update	replace	resource_group_name, instance_name, dataflow_profile_name, subscription_id		Create a DataflowProfileResource.
delete	delete	resource_group_name, instance_name, dataflow_profile_name, subscription_id		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
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 DataflowProfileResource.

SELECT
id,
name,
diagnostics,
extendedLocation,
healthState,
instanceCount,
provisioningState,
status,
systemData,
type
FROM azure.iot_operations.dataflow_profile
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
;

list_by_resource_group

List DataflowProfileResource resources by InstanceResource.

SELECT
id,
name,
diagnostics,
extendedLocation,
healthState,
instanceCount,
provisioningState,
status,
systemData,
type
FROM azure.iot_operations.dataflow_profile
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 DataflowProfileResource.

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

Manifest

# Description fields are for documentation purposes
- name: dataflow_profile
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dataflow_profile resource.
  - name: instance_name
    value: "{{ instance_name }}"
    description: Required parameter for the dataflow_profile resource.
  - name: dataflow_profile_name
    value: "{{ dataflow_profile_name }}"
    description: Required parameter for the dataflow_profile resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dataflow_profile resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      diagnostics:
        logs:
          level: "{{ level }}"
        metrics:
          prometheusPort: {{ prometheusPort }}
      instanceCount: {{ instanceCount }}
      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 DataflowProfileResource.

REPLACE azure.iot_operations.dataflow_profile
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
type;

DELETE examples

delete

Delete a DataflowProfileResource.

DELETE FROM azure.iot_operations.dataflow_profile
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
;