Dataflow Profile - Create Or Update

服務:: IoT Operations

API 版本:: 2025-10-01

建立 DataflowProfileResource

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

URI 參數

名稱	位於	必要	類型	Description
dataflowProfileName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	實例數據流的名稱Profile 資源
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)	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	類型	Description
extendedLocation	ExtendedLocation	資源的邊緣位置。
properties	DataflowProfileProperties	此資源的資源特定屬性。

回應

名稱	類型	Description
200 OK	DataflowProfileResource	資源 'DataflowProfileResource' 更新作業成功
201 Created	DataflowProfileResource	資源 'DataflowProfileResource' 建立作業成功標題 Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	未預期的錯誤回應。

名稱

類型

Description

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
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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-10-01

{
  "properties": {
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      }
    },
    "instanceCount": 14
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  }
}

範例回覆

狀態碼:: 200

{
  "properties": {
    "diagnostics": {
      "logs": {
        "level": "rnmwokumdmebpmfxxxzvvjfdywotav"
      },
      "metrics": {
        "prometheusPort": 7581
      }
    },
    "instanceCount": 14,
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123",
  "name": "bwhcjsnnfnrmbixamyxjau",
  "type": "Microsoft.IoTOperations/instances/dataflowProfiles",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "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": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123",
  "name": "bwhcjsnnfnrmbixamyxjau",
  "type": "Microsoft.IoTOperations/instances/dataflowProfiles",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "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-10-01

{
  "properties": {
    "instanceCount": 1
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  }
}

範例回覆

狀態碼:: 200

{
  "properties": {
    "instanceCount": 1,
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123",
  "name": "bwhcjsnnfnrmbixamyxjau",
  "type": "Microsoft.IoTOperations/instances/dataflowProfiles",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

狀態碼:: 201

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

{
  "properties": {
    "instanceCount": 1,
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123",
  "name": "bwhcjsnnfnrmbixamyxjau",
  "type": "Microsoft.IoTOperations/instances/dataflowProfiles",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "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-10-01

{
  "properties": {
    "instanceCount": 3
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  }
}

範例回覆

狀態碼:: 200

{
  "properties": {
    "instanceCount": 3,
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123",
  "name": "bwhcjsnnfnrmbixamyxjau",
  "type": "Microsoft.IoTOperations/instances/dataflowProfiles",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

狀態碼:: 201

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

{
  "properties": {
    "instanceCount": 3,
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
    "type": "CustomLocation"
  },
  "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123",
  "name": "bwhcjsnnfnrmbixamyxjau",
  "type": "Microsoft.IoTOperations/instances/dataflowProfiles",
  "systemData": {
    "createdBy": "contosouser",
    "createdByType": "User",
    "createdAt": "2024-08-09T18:13:29.389Z",
    "lastModifiedBy": "contosouser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-08-09T18:13:29.389Z"
  }
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
DataflowProfileProperties	DataflowProfile 資源屬性
DataflowProfileResource	執行個體 dataflowProfile 資源
DiagnosticsLogs	診斷記錄屬性
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ExtendedLocation	擴充位置是 Azure 位置的延伸模組。它們提供一種方式，可使用已啟用 Azure ARC 的 Kubernetes 叢集作為部署 Azure 服務執行個體的目標位置。
ExtendedLocationType	接受的列舉定義 ExtendedLocation 類型。
Metrics	診斷計量屬性
ProfileDiagnostics	DataflowProfile Diagnostics 屬性
ProvisioningState	定義資源狀態的列舉。
ResourceHealthState	資源的健康情況狀態。
systemData	與建立和上次修改資源相關的元數據。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

DataflowProfileProperties

Object

DataflowProfile 資源屬性

名稱	類型	預設值	Description
diagnostics	ProfileDiagnostics		規格會定義 NBC 診斷設定所需的身分識別。
healthState	ResourceHealthState	Unknown	資源的健康情況狀態。
instanceCount	integer (int32) minimum: 1 maximum: 20	1	若要手動調整數據流配置檔，請指定您想要執行的實例數目上限。
provisioningState	ProvisioningState		上次作業的狀態。

DataflowProfileResource

Object

執行個體 dataflowProfile 資源

名稱	類型	Description
extendedLocation	ExtendedLocation	資源的邊緣位置。
id	string (arm-id)	資源的完整資源標識碼。例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties	DataflowProfileProperties	此資源的資源特定屬性。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

DiagnosticsLogs

Object

診斷記錄屬性

名稱	類型	預設值	Description
level	string	info	記錄層級。範例 - 'debug'、'info'、'warn'、'error'、'trace'。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

ExtendedLocation

Object

擴充位置是 Azure 位置的延伸模組。它們提供一種方式，可使用已啟用 Azure ARC 的 Kubernetes 叢集作為部署 Azure 服務執行個體的目標位置。

名稱	類型	Description
name	string	擴充位置的名稱。
type	ExtendedLocationType	ExtendedLocation 的類型。

ExtendedLocationType

列舉型別

接受的列舉定義 ExtendedLocation 類型。

值	Description
CustomLocation	CustomLocation 類型

Metrics

Object

診斷計量屬性

名稱	類型	預設值	Description
prometheusPort	integer (int32) minimum: 0 maximum: 65535	9600	要公開計量的 prometheus 埠。

ProfileDiagnostics

Object

DataflowProfile Diagnostics 屬性

名稱	類型	Description
logs	DiagnosticsLogs	資源的診斷記錄設定。
metrics	Metrics	資源的計量設定。

ProvisioningState

列舉型別

定義資源狀態的列舉。

值	Description
Succeeded	資源已建立。
Failed	資源建立失敗。
Canceled	資源建立已取消。
Provisioning	資源正在佈建中。
Updating	資源正在更新中。
Deleting	資源正在刪除。
Accepted	資源已被接受。

ResourceHealthState

列舉型別

資源的健康情況狀態。

值	Description
Available	資源可用且如預期般運作。
Degraded	資源健康情況已降低。
Unavailable	資源未如預期般運作。
Unknown	資源狀態未知。

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
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

ResourceHealthState

systemData