Dataflow Profile - Create Or Update

Reference

Service:: IoT Operations

API Version:: 2024-08-15-preview

Create a DataflowProfileResource

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}?api-version=2024-08-15-preview

URI Parameters

Name	In	Required	Type	Description
dataflowProfileName	path	True	string	Name of Instance dataflowProfile resource Regex pattern: `^[a-z0-9][a-z0-9-]*[a-z0-9]$`
instanceName	path	True	string	Name of instance. Regex pattern: `^[a-z0-9][a-z0-9-]*[a-z0-9]$`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
extendedLocation	True	ExtendedLocation	Edge location of the resource.
properties		DataflowProfileProperties	The resource-specific properties for this resource.

Responses

Name	Type	Description
200 OK	DataflowProfileResource	Resource 'DataflowProfileResource' update operation succeeded
201 Created	DataflowProfileResource	Resource 'DataflowProfileResource' create operation succeeded Headers Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

Name

Type

Description

200 OK

DataflowProfileResource

Resource 'DataflowProfileResource' update operation succeeded

201 Created

DataflowProfileResource

Resource 'DataflowProfileResource' create operation succeeded

Headers

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

DataflowProfile_CreateOrUpdate

DataflowProfile_CreateOrUpdate_Minimal

DataflowProfile_CreateOrUpdate_Multi

DataflowProfile_CreateOrUpdate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123?api-version=2024-08-15-preview

{
  "properties": {
    "diagnostics": {
      "logs": {
        "opentelemetryExportConfig": {
          "otlpGrpcEndpoint": "tbfsk",
          "intervalSeconds": 145,
          "level": "rwq"
        },
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "opentelemetryExportConfig": {
          "otlpGrpcEndpoint": "iwbklzcm",
          "intervalSeconds": 98
        },
        "prometheusPort": 7581
      }
    },
    "instanceCount": 14
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Sample response

Status code:: 200

{
  "properties": {
    "diagnostics": {
      "logs": {
        "opentelemetryExportConfig": {
          "otlpGrpcEndpoint": "tbfsk",
          "intervalSeconds": 145,
          "level": "rwq"
        },
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "opentelemetryExportConfig": {
          "otlpGrpcEndpoint": "iwbklzcm",
          "intervalSeconds": 98
        },
        "prometheusPort": 7581
      }
    },
    "instanceCount": 14,
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123",
  "name": "bwhcjsnnfnrmbixamyxjau",
  "type": "ejvancsomtbapgztnerhlvx",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Status code:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "properties": {
    "diagnostics": {
      "logs": {
        "opentelemetryExportConfig": {
          "otlpGrpcEndpoint": "tbfsk",
          "intervalSeconds": 145,
          "level": "rwq"
        },
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "opentelemetryExportConfig": {
          "otlpGrpcEndpoint": "iwbklzcm",
          "intervalSeconds": 98
        },
        "prometheusPort": 7581
      }
    },
    "instanceCount": 14,
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123",
  "name": "bwhcjsnnfnrmbixamyxjau",
  "type": "ejvancsomtbapgztnerhlvx",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

DataflowProfile_CreateOrUpdate_Minimal

Sample request

HTTP

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/aio-dataflowprofile?api-version=2024-08-15-preview

{
  "properties": {
    "instanceCount": 1
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Sample response

Status code:: 200

{
  "properties": {
    "instanceCount": 1,
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123",
  "name": "bwhcjsnnfnrmbixamyxjau",
  "type": "ejvancsomtbapgztnerhlvx",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Status code:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "properties": {
    "instanceCount": 1,
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123",
  "name": "bwhcjsnnfnrmbixamyxjau",
  "type": "ejvancsomtbapgztnerhlvx",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

DataflowProfile_CreateOrUpdate_Multi

Sample request

HTTP

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/aio-dataflowprofile?api-version=2024-08-15-preview

{
  "properties": {
    "instanceCount": 3
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

Sample response

Status code:: 200

{
  "properties": {
    "instanceCount": 3,
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123",
  "name": "bwhcjsnnfnrmbixamyxjau",
  "type": "ejvancsomtbapgztnerhlvx",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Status code:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "properties": {
    "instanceCount": 3,
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123",
  "name": "bwhcjsnnfnrmbixamyxjau",
  "type": "ejvancsomtbapgztnerhlvx",
  "systemData": {
    "createdBy": "ssvaslsmudloholronopqyxjcu",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "gnicpuszwd",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DataflowProfileProperties	DataflowProfile Resource properties
DataflowProfileResource	Instance dataflowProfile resource
DiagnosticsLogs	Diagnostic Log properties
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedLocation	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.
ExtendedLocationType	The enum defining type of ExtendedLocation accepted.
Metrics	Diagnostic Metrics properties
OpenTelemetryExportConfig	OpenTelemetry Export Configuration properties
OpenTelemetryLogExportConfig	OpenTelemetry Log Export Configuration properties
ProfileDiagnostics	DataflowProfile Diagnostics properties
ProvisioningState	The enum defining status of resource.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataflowProfileProperties

DataflowProfile Resource properties

Name	Type	Default value	Description
diagnostics	ProfileDiagnostics		Spec defines the desired identities of NBC diagnostics settings.
instanceCount	integer	1	To manually scale the dataflow profile, specify the maximum number of instances you want to run.
provisioningState	ProvisioningState		The status of the last operation.

DataflowProfileResource

Instance dataflowProfile resource

Name	Type	Description
extendedLocation	ExtendedLocation	Edge location of the resource.
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	DataflowProfileProperties	The resource-specific properties for this resource.
systemData	systemData	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"

DiagnosticsLogs

Diagnostic Log properties

Name	Type	Default value	Description
level	string	info	The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'.
opentelemetryExportConfig	OpenTelemetryLogExportConfig		The open telemetry export configuration.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExtendedLocation

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.

Name	Type	Description
name	string	The name of the extended location.
type	ExtendedLocationType	Type of ExtendedLocation.

ExtendedLocationType

The enum defining type of ExtendedLocation accepted.

Name	Type	Description
CustomLocation	string	CustomLocation type

Metrics

Diagnostic Metrics properties

Name	Type	Default value	Description
opentelemetryExportConfig	OpenTelemetryExportConfig		The open telemetry export configuration.
prometheusPort	integer	9600	The prometheus port to expose the metrics.

OpenTelemetryExportConfig

OpenTelemetry Export Configuration properties

Name	Type	Default value	Description
intervalSeconds	integer	30	How often to export the metrics to the open telemetry collector.
otlpGrpcEndpoint	string		The open telemetry collector endpoint to export to.

OpenTelemetryLogExportConfig

OpenTelemetry Log Export Configuration properties

Name	Type	Default value	Description
intervalSeconds	integer	30	How often to export the metrics to the open telemetry collector.
level	string	error	The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'.
otlpGrpcEndpoint	string		The open telemetry collector endpoint to export to.

ProfileDiagnostics

DataflowProfile Diagnostics properties

Name	Type	Description
logs	DiagnosticsLogs	Diagnostic log settings for the resource.
metrics	Metrics	The metrics settings for the resource.

ProvisioningState

The enum defining status of resource.

Name	Type	Description
Accepted	string	Resource has been Accepted.
Canceled	string	Resource creation was canceled.
Deleting	string	Resource is Deleting.
Failed	string	Resource creation failed.
Provisioning	string	Resource is getting provisioned.
Succeeded	string	Resource has been created.
Updating	string	Resource is Updating.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Dataflow Profile - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

DataflowProfile_CreateOrUpdate

Sample request

Sample response

DataflowProfile_CreateOrUpdate_Minimal

Sample request

Sample response

DataflowProfile_CreateOrUpdate_Multi

Sample request

Sample response

Definitions

createdByType

DataflowProfileProperties

DataflowProfileResource

DiagnosticsLogs

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationType

Metrics

OpenTelemetryExportConfig

OpenTelemetryLogExportConfig

ProfileDiagnostics

ProvisioningState

systemData

Additional resources