Microsoft.IoTOperations instances/dataflowProfiles 2024-07-01-preview
Bicep resource definition
The instances/dataflowProfiles resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.IoTOperations/instances/dataflowProfiles resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.IoTOperations/instances/dataflowProfiles@2024-07-01-preview' = {
parent: resourceSymbolicName
extendedLocation: {
name: 'string'
type: 'string'
}
name: 'string'
properties: {
diagnostics: {
logs: {
level: 'string'
opentelemetryExportConfig: {
intervalSeconds: int
level: 'string'
otlpGrpcEndpoint: 'string'
}
}
metrics: {
opentelemetryExportConfig: {
intervalSeconds: int
otlpGrpcEndpoint: 'string'
}
prometheusPort: int
}
}
instanceCount: int
}
}
Property values
DataFlowProfileProperties
| Name | Description | Value |
|---|---|---|
| diagnostics | Spec defines the desired identities of NBC diagnostics settings. | ProfileDiagnostics |
| instanceCount | To manually scale the dataflow profile, specify the maximum number of instances you want to run. | int Constraints: Min value = 1 Max value = 20 |
DiagnosticsLogs
| Name | Description | Value |
|---|---|---|
| level | The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. | string |
| opentelemetryExportConfig | The open telemetry export configuration. | OpenTelemetryLogExportConfig |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string (required) |
| type | Type of ExtendedLocation. | 'CustomLocation' (required) |
Metrics
| Name | Description | Value |
|---|---|---|
| opentelemetryExportConfig | The open telemetry export configuration. | OpenTelemetryExportConfig |
| prometheusPort | The prometheus port to expose the metrics. | int Constraints: Min value = 0 Max value = 65535 |
Microsoft.IoTOperations/instances/dataflowProfiles
| Name | Description | Value |
|---|---|---|
| extendedLocation | Edge location of the resource. | ExtendedLocation (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: instances |
| properties | The resource-specific properties for this resource. | DataFlowProfileProperties |
OpenTelemetryExportConfig
| Name | Description | Value |
|---|---|---|
| intervalSeconds | How often to export the metrics to the open telemetry collector. | int Constraints: Min value = 1 Max value = 300 |
| otlpGrpcEndpoint | The open telemetry collector endpoint to export to. | string (required) |
OpenTelemetryLogExportConfig
| Name | Description | Value |
|---|---|---|
| intervalSeconds | How often to export the metrics to the open telemetry collector. | int Constraints: Min value = 1 Max value = 300 |
| level | The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. | string |
| otlpGrpcEndpoint | The open telemetry collector endpoint to export to. | string (required) |
ProfileDiagnostics
| Name | Description | Value |
|---|---|---|
| logs | Diagnostic log settings for the resource. | DiagnosticsLogs |
| metrics | The metrics settings for the resource. | Metrics |
ARM template resource definition
The instances/dataflowProfiles resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.IoTOperations/instances/dataflowProfiles resource, add the following JSON to your template.
{
"type": "Microsoft.IoTOperations/instances/dataflowProfiles",
"apiVersion": "2024-07-01-preview",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"properties": {
"diagnostics": {
"logs": {
"level": "string",
"opentelemetryExportConfig": {
"intervalSeconds": "int",
"level": "string",
"otlpGrpcEndpoint": "string"
}
},
"metrics": {
"opentelemetryExportConfig": {
"intervalSeconds": "int",
"otlpGrpcEndpoint": "string"
},
"prometheusPort": "int"
}
},
"instanceCount": "int"
}
}
Property values
DataFlowProfileProperties
| Name | Description | Value |
|---|---|---|
| diagnostics | Spec defines the desired identities of NBC diagnostics settings. | ProfileDiagnostics |
| instanceCount | To manually scale the dataflow profile, specify the maximum number of instances you want to run. | int Constraints: Min value = 1 Max value = 20 |
DiagnosticsLogs
| Name | Description | Value |
|---|---|---|
| level | The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. | string |
| opentelemetryExportConfig | The open telemetry export configuration. | OpenTelemetryLogExportConfig |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string (required) |
| type | Type of ExtendedLocation. | 'CustomLocation' (required) |
Metrics
| Name | Description | Value |
|---|---|---|
| opentelemetryExportConfig | The open telemetry export configuration. | OpenTelemetryExportConfig |
| prometheusPort | The prometheus port to expose the metrics. | int Constraints: Min value = 0 Max value = 65535 |
Microsoft.IoTOperations/instances/dataflowProfiles
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-07-01-preview' |
| extendedLocation | Edge location of the resource. | ExtendedLocation (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (required) |
| properties | The resource-specific properties for this resource. | DataFlowProfileProperties |
| type | The resource type | 'Microsoft.IoTOperations/instances/dataflowProfiles' |
OpenTelemetryExportConfig
| Name | Description | Value |
|---|---|---|
| intervalSeconds | How often to export the metrics to the open telemetry collector. | int Constraints: Min value = 1 Max value = 300 |
| otlpGrpcEndpoint | The open telemetry collector endpoint to export to. | string (required) |
OpenTelemetryLogExportConfig
| Name | Description | Value |
|---|---|---|
| intervalSeconds | How often to export the metrics to the open telemetry collector. | int Constraints: Min value = 1 Max value = 300 |
| level | The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. | string |
| otlpGrpcEndpoint | The open telemetry collector endpoint to export to. | string (required) |
ProfileDiagnostics
| Name | Description | Value |
|---|---|---|
| logs | Diagnostic log settings for the resource. | DiagnosticsLogs |
| metrics | The metrics settings for the resource. | Metrics |
Terraform (AzAPI provider) resource definition
The instances/dataflowProfiles resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.IoTOperations/instances/dataflowProfiles resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.IoTOperations/instances/dataflowProfiles@2024-07-01-preview"
name = "string"
body = jsonencode({
extendedLocation = {
name = "string"
type = "string"
}
properties = {
diagnostics = {
logs = {
level = "string"
opentelemetryExportConfig = {
intervalSeconds = int
level = "string"
otlpGrpcEndpoint = "string"
}
}
metrics = {
opentelemetryExportConfig = {
intervalSeconds = int
otlpGrpcEndpoint = "string"
}
prometheusPort = int
}
}
instanceCount = int
}
})
}
Property values
DataFlowProfileProperties
| Name | Description | Value |
|---|---|---|
| diagnostics | Spec defines the desired identities of NBC diagnostics settings. | ProfileDiagnostics |
| instanceCount | To manually scale the dataflow profile, specify the maximum number of instances you want to run. | int Constraints: Min value = 1 Max value = 20 |
DiagnosticsLogs
| Name | Description | Value |
|---|---|---|
| level | The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. | string |
| opentelemetryExportConfig | The open telemetry export configuration. | OpenTelemetryLogExportConfig |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string (required) |
| type | Type of ExtendedLocation. | 'CustomLocation' (required) |
Metrics
| Name | Description | Value |
|---|---|---|
| opentelemetryExportConfig | The open telemetry export configuration. | OpenTelemetryExportConfig |
| prometheusPort | The prometheus port to expose the metrics. | int Constraints: Min value = 0 Max value = 65535 |
Microsoft.IoTOperations/instances/dataflowProfiles
| Name | Description | Value |
|---|---|---|
| extendedLocation | Edge location of the resource. | ExtendedLocation (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: instances |
| properties | The resource-specific properties for this resource. | DataFlowProfileProperties |
| type | The resource type | "Microsoft.IoTOperations/instances/dataflowProfiles@2024-07-01-preview" |
OpenTelemetryExportConfig
| Name | Description | Value |
|---|---|---|
| intervalSeconds | How often to export the metrics to the open telemetry collector. | int Constraints: Min value = 1 Max value = 300 |
| otlpGrpcEndpoint | The open telemetry collector endpoint to export to. | string (required) |
OpenTelemetryLogExportConfig
| Name | Description | Value |
|---|---|---|
| intervalSeconds | How often to export the metrics to the open telemetry collector. | int Constraints: Min value = 1 Max value = 300 |
| level | The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. | string |
| otlpGrpcEndpoint | The open telemetry collector endpoint to export to. | string (required) |
ProfileDiagnostics
| Name | Description | Value |
|---|---|---|
| logs | Diagnostic log settings for the resource. | DiagnosticsLogs |
| metrics | The metrics settings for the resource. | Metrics |