Dataflow Profile - Create Or Update

Serviço:: IoT Operations

Versão da API:: 2026-03-01

Criar um DataflowProfileResource

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
dataflowProfileName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Nome do recurso dataflowProfile da instância
instanceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Nome da instância.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
extendedLocation	ExtendedLocation	Localização de borda do recurso.
properties	DataflowProfileProperties	As propriedades específicas do recurso para este recurso.

Respostas

Name	Tipo	Description
200 OK	DataflowProfileResource	Operação de atualização do recurso 'DataflowProfileResource' bem-sucedida
201 Created	DataflowProfileResource	Recurso 'DataflowProfileResource' criar operação bem-sucedida Cabeçalhos Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Name

Tipo

Description

200 OK

DataflowProfileResource

Operação de atualização do recurso 'DataflowProfileResource' bem-sucedida

201 Created

DataflowProfileResource

Recurso 'DataflowProfileResource' criar operação bem-sucedida

Cabeçalhos

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

DataflowProfile_CreateOrUpdate

DataflowProfile_CreateOrUpdate_Minimal

DataflowProfile_CreateOrUpdate_Multi

DataflowProfile_CreateOrUpdate

PUT https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123?api-version=2026-03-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"
  }
}

const { IoTOperationsClient } = require("@azure/arm-iotoperations");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create a DataflowProfileResource
 *
 * @summary create a DataflowProfileResource
 * x-ms-original-file: 2026-03-01/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json
 */
async function dataflowProfileCreateOrUpdate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "F8C729F9-DF9C-4743-848F-96EE433D8E53";
  const client = new IoTOperationsClient(credential, subscriptionId);
  const result = await client.dataflowProfile.createOrUpdate(
    "rgiotoperations",
    "resource-name123",
    "resource-name123",
    {
      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",
      },
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 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

Pedido de amostra

HTTP
JavaScript

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

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

const { IoTOperationsClient } = require("@azure/arm-iotoperations");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create a DataflowProfileResource
 *
 * @summary create a DataflowProfileResource
 * x-ms-original-file: 2026-03-01/DataflowProfile_CreateOrUpdate_Minimal.json
 */
async function dataflowProfileCreateOrUpdateMinimal() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "F8C729F9-DF9C-4743-848F-96EE433D8E53";
  const client = new IoTOperationsClient(credential, subscriptionId);
  const result = await client.dataflowProfile.createOrUpdate(
    "rgiotoperations",
    "resource-name123",
    "aio-dataflowprofile",
    {
      properties: { instanceCount: 1 },
      extendedLocation: {
        name: "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
        type: "CustomLocation",
      },
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 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

Pedido de amostra

HTTP
JavaScript

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

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

const { IoTOperationsClient } = require("@azure/arm-iotoperations");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create a DataflowProfileResource
 *
 * @summary create a DataflowProfileResource
 * x-ms-original-file: 2026-03-01/DataflowProfile_CreateOrUpdate_Multi.json
 */
async function dataflowProfileCreateOrUpdateMulti() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "F8C729F9-DF9C-4743-848F-96EE433D8E53";
  const client = new IoTOperationsClient(credential, subscriptionId);
  const result = await client.dataflowProfile.createOrUpdate(
    "rgiotoperations",
    "resource-name123",
    "aio-dataflowprofile",
    {
      properties: { instanceCount: 3 },
      extendedLocation: {
        name: "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
        type: "CustomLocation",
      },
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 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"
  }
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
DataflowProfileProperties	Propriedades do recurso DataflowProfile
DataflowProfileResource	Recurso dataflowProfile da instância
DataflowProfileStatus	Estado do DataflowProfile.
DiagnosticsLogs	Propriedades do log de diagnóstico
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ExtendedLocation	O local estendido é uma extensão dos locais do Azure. Eles fornecem uma maneira de usar seus clusters Kubernetes habilitados para Azure ARC como locais de destino para implantar instâncias de serviços do Azure.
ExtendedLocationType	O enum que define o tipo de ExtendedLocation aceito.
Metrics	Propriedades de métricas de diagnóstico
ProfileDiagnostics	Propriedades do DataflowProfile Diagnostics
ProvisioningState	O enum que define o status do recurso.
ResourceHealthState	O estado de saúde do recurso.
ResourceHealthStatus	Representa o estado de saúde de um recurso.
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DataflowProfileProperties

Object

Propriedades do recurso DataflowProfile

Name	Tipo	Default value	Description
diagnostics	ProfileDiagnostics		Spec define as identidades desejadas das configurações de diagnóstico NBC.
healthState	ResourceHealthState	Unknown	O estado de saúde do recurso.
instanceCount	integer (int32) minimum: 1 maximum: 20	1	Para dimensionar manualmente o perfil de fluxo de dados, especifique o número máximo de instâncias que você deseja executar.
provisioningState	ProvisioningState		O status da última operação.
status	DataflowProfileStatus		O estado do perfil de fluxo de dados.

DataflowProfileResource

Object

Recurso dataflowProfile da instância

Name	Tipo	Description
extendedLocation	ExtendedLocation	Localização de borda do recurso.
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties	DataflowProfileProperties	As propriedades específicas do recurso para este recurso.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

DataflowProfileStatus

Object

Estado do DataflowProfile.

Name	Tipo	Description
healthState	ResourceHealthStatus	O estado de saúde do DataflowProfile.

DiagnosticsLogs

Object

Propriedades do log de diagnóstico

Name	Tipo	Default value	Description
level	string	info	O nível de log. Exemplos - 'debug', 'info', 'warn', 'error', 'trace'.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExtendedLocation

Object

O local estendido é uma extensão dos locais do Azure. Eles fornecem uma maneira de usar seus clusters Kubernetes habilitados para Azure ARC como locais de destino para implantar instâncias de serviços do Azure.

Name	Tipo	Description
name	string	O nome do local estendido.
type	ExtendedLocationType	Tipo de ExtendedLocation.

ExtendedLocationType

Enumeração

O enum que define o tipo de ExtendedLocation aceito.

Valor	Description
CustomLocation	Tipo CustomLocation

Metrics

Object

Propriedades de métricas de diagnóstico

Name	Tipo	Default value	Description
prometheusPort	integer (int32) minimum: 0 maximum: 65535	9600	A porta prometheus para expor as métricas.

ProfileDiagnostics

Object

Propriedades do DataflowProfile Diagnostics

Name	Tipo	Description
logs	DiagnosticsLogs	Configurações de log de diagnóstico para o recurso.
metrics	Metrics	As configurações de métricas para o recurso.

ProvisioningState

Enumeração

O enum que define o status do recurso.

Valor	Description
Succeeded	O recurso foi criado.
Failed	Falha na criação de recursos.
Canceled	A criação de recursos foi cancelada.
Provisioning	O recurso está sendo provisionado.
Updating	O recurso está se atualizando.
Deleting	O recurso está sendo excluído.
Accepted	O recurso foi aceito.

ResourceHealthState

Enumeração

O estado de saúde do recurso.

Valor	Description
Available	O recurso está disponível e funcionando conforme o esperado.
Degraded	A integridade dos recursos está degradada.
Unavailable	O recurso não está funcionando como esperado.
Unknown	O estado do recurso é desconhecido.

ResourceHealthStatus

Object

Representa o estado de saúde de um recurso.

Name	Tipo	Description
lastTransitionTime	string	O carimbo temporal (RFC3339) em que o estado de saúde foi alterado pela última vez.
lastUpdateTime	string	O carimbo temporal (RFC3339) em que o estado de saúde foi atualizado pela última vez, mesmo que o estado não tenha mudado.
message	string	Uma mensagem legível para humanos a descrever a última transição.
reasonCode	string	Código de razão único, CamelCase que descreve a causa da última transição do estado de saúde.
status	ResourceHealthState	O estado de saúde elevado do recurso.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.