你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Dataflow Profile - Create Or Update

参考

服务:: IoT Operations

API 版本:: 2025-04-01

创建 DataflowProfileResource

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}?api-version=2025-04-01

URI 参数

名称	在	必需	类型	说明
dataflowProfileName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	实例数据流资源的名称
instanceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	实例的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	必需	类型	说明
extendedLocation	True	ExtendedLocation	资源的边缘位置。
properties		DataflowProfileProperties	此资源的资源特定属性。

响应

名称	类型	说明
200 OK	DataflowProfileResource	资源“DataflowProfileResource”更新作成功
201 Created	DataflowProfileResource	资源“DataflowProfileResource”创建作成功标头 Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	意外的错误响应。

名称

类型

说明

200 OK

DataflowProfileResource

资源“DataflowProfileResource”更新作成功

201 Created

DataflowProfileResource

资源“DataflowProfileResource”创建作成功

标头

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

ErrorResponse

意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

DataflowProfile_CreateOrUpdate

DataflowProfile_CreateOrUpdate_Minimal

DataflowProfile_CreateOrUpdate_Multi

DataflowProfile_CreateOrUpdate

示例请求

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=2025-04-01

{
  "properties": {
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      }
    },
    "instanceCount": 14
  },
  "extendedLocation": {
    "name": "qmbrfwcpwwhggszhrdjv",
    "type": "CustomLocation"
  }
}

示例响应

状态代码:: 200

{
  "properties": {
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "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"
  }
}

状态代码:: 201

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

{
  "properties": {
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "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

示例请求

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=2025-04-01

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

示例响应

状态代码:: 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"
  }
}

状态代码:: 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

示例请求

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=2025-04-01

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

示例响应

状态代码:: 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"
  }
}

状态代码:: 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"
  }
}

定义

名称	说明
createdByType	创建资源的标识的类型。
DataflowProfileProperties	DataflowProfile 资源属性
DataflowProfileResource	实例数据流Profile 资源
DiagnosticsLogs	诊断日志属性
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ExtendedLocation	扩展位置是 Azure 位置的扩展。他们提供了一种使用已启用 Azure ARC 的 Kubernetes 群集作为部署 Azure 服务实例的目标位置的方法。
ExtendedLocationType	已接受 ExtendedLocation 的枚举类型。
Metrics	诊断指标属性
ProfileDiagnostics	DataflowProfile 诊断属性
ProvisioningState	定义资源状态的枚举。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DataflowProfileProperties

Object

DataflowProfile 资源属性

名称	类型	默认值	说明
diagnostics	ProfileDiagnostics		规范定义 NBC 诊断设置的所需标识。
instanceCount	integer (int32) minimum: 1 maximum: 20	1	若要手动缩放数据流配置文件，请指定要运行的最大实例数。
provisioningState	ProvisioningState		上次作的状态。

DataflowProfileResource

Object

实例数据流Profile 资源

名称	类型	说明
extendedLocation	ExtendedLocation	资源的边缘位置。
id	string (arm-id)	资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties	DataflowProfileProperties	此资源的资源特定属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

DiagnosticsLogs

Object

诊断日志属性

名称	类型	默认值	说明
level	string	info	日志级别。示例 - “debug”、“info”、“warn”、“error”、“trace”。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ExtendedLocation

Object

扩展位置是 Azure 位置的扩展。他们提供了一种使用已启用 Azure ARC 的 Kubernetes 群集作为部署 Azure 服务实例的目标位置的方法。

名称	类型	说明
name	string	扩展位置的名称。
type	ExtendedLocationType	ExtendedLocation 的类型。

ExtendedLocationType

枚举

已接受 ExtendedLocation 的枚举类型。

值	说明
CustomLocation	CustomLocation 类型

Metrics

Object

诊断指标属性

名称	类型	默认值	说明
prometheusPort	integer (int32) minimum: 0 maximum: 65535	9600	用于公开指标的 prometheus 端口。

ProfileDiagnostics

Object

DataflowProfile 诊断属性

名称	类型	说明
logs	DiagnosticsLogs	资源的诊断日志设置。
metrics	Metrics	资源的指标设置。

ProvisioningState

枚举

定义资源状态的枚举。

值	说明
Accepted	资源已被接受。
Canceled	资源创建已取消。
Deleting	资源正在删除。
Failed	资源创建失败。
Provisioning	正在预配资源。
Succeeded	已创建资源。
Updating	资源正在更新。

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

通过

Dataflow Profile - Create Or Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

DataflowProfile_CreateOrUpdate

示例请求

示例响应

DataflowProfile_CreateOrUpdate_Minimal

示例请求

示例响应

DataflowProfile_CreateOrUpdate_Multi

示例请求

示例响应

定义

createdByType

DataflowProfileProperties

DataflowProfileResource

DiagnosticsLogs

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationType

Metrics

ProfileDiagnostics

ProvisioningState

systemData