Dataflow Profile - Create Or Update
Creare un oggetto DataflowProfileResource
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}?api-version=2025-04-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
dataflow
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Nome della risorsa dataflowProfile dell'istanza |
instance
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ |
Nome dell'istanza. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole. |
subscription
|
path | True |
string (uuid) |
ID della sottoscrizione di destinazione. Il valore deve essere un UUID. |
api-version
|
query | True |
string minLength: 1 |
Versione dell'API da usare per questa operazione. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
extendedLocation | True |
Posizione perimetrale della risorsa. |
|
properties |
Proprietà specifiche della risorsa. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Operazione di aggiornamento della risorsa 'DataflowProfileResource' completata |
|
201 Created |
Operazione di creazione della risorsa 'DataflowProfileResource' completata Intestazioni
|
|
Other Status Codes |
Risposta di errore imprevista. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
Dataflow |
Dataflow |
Dataflow |
DataflowProfile_CreateOrUpdate
Esempio di richiesta
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"
}
}
Risposta di esempio
{
"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"
}
}
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
Esempio di richiesta
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"
}
}
Risposta di esempio
{
"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"
}
}
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
Esempio di richiesta
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"
}
}
Risposta di esempio
{
"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"
}
}
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"
}
}
Definizioni
Nome | Descrizione |
---|---|
created |
Tipo di identità che ha creato la risorsa. |
Dataflow |
Proprietà della risorsa DataflowProfile |
Dataflow |
Risorsa dataflowProfile dell'istanza |
Diagnostics |
Proprietà del log di diagnostica |
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
Error |
Dettagli dell'errore. |
Error |
Risposta di errore |
Extended |
La posizione estesa è un'estensione delle località di Azure. Offrono un modo per usare i cluster Kubernetes con abilitazione di Azure ARC come percorsi di destinazione per la distribuzione delle istanze dei servizi di Azure. |
Extended |
Enumerazione che definisce il tipo di ExtendedLocation accettato. |
Metrics |
Proprietà delle metriche di diagnostica |
Profile |
Proprietà di diagnostica DataflowProfile |
Provisioning |
Enumerazione che definisce lo stato della risorsa. |
system |
Metadati relativi alla creazione e all'ultima modifica della risorsa. |
createdByType
Tipo di identità che ha creato la risorsa.
Valore | Descrizione |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
DataflowProfileProperties
Proprietà della risorsa DataflowProfile
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
diagnostics |
Specifica definisce le identità desiderate delle impostazioni di diagnostica NBC. |
||
instanceCount |
integer (int32) minimum: 1maximum: 20 |
1 |
Per ridimensionare manualmente il profilo del flusso di dati, specificare il numero massimo di istanze da eseguire. |
provisioningState |
Stato dell'ultima operazione. |
DataflowProfileResource
Risorsa dataflowProfile dell'istanza
Nome | Tipo | Descrizione |
---|---|---|
extendedLocation |
Posizione perimetrale della risorsa. |
|
id |
string (arm-id) |
ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
Nome della risorsa |
properties |
Proprietà specifiche della risorsa. |
|
systemData |
Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy. |
|
type |
string |
Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
DiagnosticsLogs
Proprietà del log di diagnostica
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
level |
string |
info |
Livello di log. Esempi: 'debug', 'info', 'warn', 'error', 'trace'. |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
info |
object |
Informazioni aggiuntive. |
type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
Nome | Tipo | Descrizione |
---|---|---|
additionalInfo |
Informazioni aggiuntive sull'errore. |
|
code |
string |
Codice di errore. |
details |
Dettagli dell'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
ErrorResponse
Risposta di errore
Nome | Tipo | Descrizione |
---|---|---|
error |
Oggetto error. |
ExtendedLocation
La posizione estesa è un'estensione delle località di Azure. Offrono un modo per usare i cluster Kubernetes con abilitazione di Azure ARC come percorsi di destinazione per la distribuzione delle istanze dei servizi di Azure.
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
Nome della posizione estesa. |
type |
Tipo di ExtendedLocation. |
ExtendedLocationType
Enumerazione che definisce il tipo di ExtendedLocation accettato.
Valore | Descrizione |
---|---|
CustomLocation |
Tipo CustomLocation |
Metrics
Proprietà delle metriche di diagnostica
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
prometheusPort |
integer (int32) minimum: 0maximum: 65535 |
9600 |
Porta prometheus per esporre le metriche. |
ProfileDiagnostics
Proprietà di diagnostica DataflowProfile
Nome | Tipo | Descrizione |
---|---|---|
logs |
Impostazioni del log di diagnostica per la risorsa. |
|
metrics |
Impostazioni delle metriche per la risorsa. |
ProvisioningState
Enumerazione che definisce lo stato della risorsa.
Valore | Descrizione |
---|---|
Accepted |
La risorsa è stata accettata. |
Canceled |
La creazione della risorsa è stata annullata. |
Deleting |
La risorsa è l'eliminazione. |
Failed |
Creazione della risorsa non riuscita. |
Provisioning |
Viene effettuato il provisioning della risorsa. |
Succeeded |
La risorsa è stata creata. |
Updating |
La risorsa è l'aggiornamento. |
systemData
Metadati relativi alla creazione e all'ultima modifica della risorsa.
Nome | Tipo | Descrizione |
---|---|---|
createdAt |
string (date-time) |
Timestamp della creazione della risorsa (UTC). |
createdBy |
string |
Identità che ha creato la risorsa. |
createdByType |
Tipo di identità che ha creato la risorsa. |
|
lastModifiedAt |
string (date-time) |
Timestamp dell'ultima modifica della risorsa (UTC) |
lastModifiedBy |
string |
Identità che ha modificato l'ultima volta la risorsa. |
lastModifiedByType |
Tipo di identità che ha modificato l'ultima volta la risorsa. |