Dataflow Profile - Create Or Update

Service:: IoT Operations

Version d'API:: 2026-03-01

Créer une DataflowProfileResource

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
dataflowProfileName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Nom de la ressource DataflowProfile d’instance
instanceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Nom de l’instance.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
extendedLocation	ExtendedLocation	Emplacement de périphérie de la ressource.
properties	DataflowProfileProperties	Propriétés spécifiques à la ressource pour cette ressource.

Réponses

Nom	Type	Description
200 OK	DataflowProfileResource	Réussite de l’opération de mise à jour de la ressource 'DataflowProfileResource'
201 Created	DataflowProfileResource	Réussite de l’opération de création de la ressource 'DataflowProfileResource' En-têtes Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

DataflowProfileResource

Réussite de l’opération de mise à jour de la ressource 'DataflowProfileResource'

201 Created

DataflowProfileResource

Réussite de l’opération de création de la ressource 'DataflowProfileResource'

En-têtes

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 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

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 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

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 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"
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
DataflowProfileProperties	Propriétés de la ressource DataflowProfile
DataflowProfileResource	Ressource dataflowProfile de l’instance
DataflowProfileStatus	DataflowProfile statut.
DiagnosticsLogs	Propriétés du journal de diagnostic
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ExtendedLocation	L’emplacement étendu est une extension des emplacements Azure. Ils permettent d’utiliser leurs clusters Kubernetes avec Azure ARC comme emplacements cibles pour le déploiement d’instances de services Azure.
ExtendedLocationType	L’énumération définissant le type de ExtendedLocation acceptée.
Metrics	Propriétés des métriques de diagnostic
ProfileDiagnostics	Propriétés de DataflowProfile Diagnostics
ProvisioningState	L’énumération définissant le statut de la ressource.
ResourceHealthState	L’état de santé de la ressource.
ResourceHealthStatus	Représente l’état de santé d’une ressource.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DataflowProfileProperties

Objet

Propriétés de la ressource DataflowProfile

Nom	Type	Valeur par défaut	Description
diagnostics	ProfileDiagnostics		La spécification définit les identités souhaitées des paramètres de diagnostic NBC.
healthState	ResourceHealthState	Unknown	L’état de santé de la ressource.
instanceCount	integer (int32) minimum: 1 maximum: 20	1	Pour mettre à l’échelle manuellement le profil de flux de données, spécifiez le nombre maximal d’instances que vous souhaitez exécuter.
provisioningState	ProvisioningState		État de la dernière opération.
status	DataflowProfileStatus		L’état du profil de flux de données.

DataflowProfileResource

Objet

Ressource dataflowProfile de l’instance

Nom	Type	Description
extendedLocation	ExtendedLocation	Emplacement de périphérie de la ressource.
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties	DataflowProfileProperties	Propriétés spécifiques à la ressource pour cette ressource.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

DataflowProfileStatus

Objet

DataflowProfile statut.

Nom	Type	Description
healthState	ResourceHealthStatus	L’état de santé du DataflowProfile.

DiagnosticsLogs

Objet

Propriétés du journal de diagnostic

Nom	Type	Valeur par défaut	Description
level	string	info	Niveau du journal. Exemples : « debug », « info », « warn », « error », « trace ».

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ExtendedLocation

Objet

L’emplacement étendu est une extension des emplacements Azure. Ils permettent d’utiliser leurs clusters Kubernetes avec Azure ARC comme emplacements cibles pour le déploiement d’instances de services Azure.

Nom	Type	Description
name	string	Nom de l’emplacement étendu.
type	ExtendedLocationType	Type de ExtendedLocation.

ExtendedLocationType

Énumération

L’énumération définissant le type de ExtendedLocation acceptée.

Valeur	Description
CustomLocation	Type de CustomLocation

Metrics

Objet

Propriétés des métriques de diagnostic

Nom	Type	Valeur par défaut	Description
prometheusPort	integer (int32) minimum: 0 maximum: 65535	9600	Port prometheus pour exposer les métriques.

ProfileDiagnostics

Objet

Propriétés de DataflowProfile Diagnostics

Nom	Type	Description
logs	DiagnosticsLogs	Paramètres du journal de diagnostic pour la ressource.
metrics	Metrics	Paramètres des métriques de la ressource.

ProvisioningState

Énumération

L’énumération définissant le statut de la ressource.

Valeur	Description
Succeeded	La ressource a été créée.
Failed	Échec de la création de ressources.
Canceled	La création de ressources a été annulée.
Provisioning	La ressource est provisionnée.
Updating	La ressource est en cours de mise à jour.
Deleting	La ressource est en train de supprimer.
Accepted	La ressource a été acceptée.

ResourceHealthState

Énumération

L’état de santé de la ressource.

Valeur	Description
Available	La ressource est disponible et fonctionne comme prévu.
Degraded	L’état de la ressource est dégradé.
Unavailable	La ressource ne fonctionne pas comme prévu.
Unknown	L’état de la ressource est inconnu.

ResourceHealthStatus

Objet

Représente l’état de santé d’une ressource.

Nom	Type	Description
lastTransitionTime	string	L’horodatage (RFC3339) de la dernière modification de l’état de santé.
lastUpdateTime	string	L’horodatage (RFC3339) de la dernière mise à jour de l’état de santé, même si le statut n’a pas changé.
message	string	Un message lisible par l’humain décrivant la dernière transition.
reasonCode	string	Code de raison unique de CamelCase décrivant la cause de la dernière transition d’état de santé.
status	ResourceHealthState	Le niveau élevé de santé de la ressource.

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.