Partager via

Background Jobs - Run On Demand Execute

Service:
Dataflow
Version d'API:
v1

Exécutez l’instance de travail d’exécution à la demande.

Note

Cette API fait partie d’une préversion et est fournie uniquement à des fins d’évaluation et de développement. Il peut changer en fonction des commentaires et n’est pas recommandé pour une utilisation en production. L’URL de cette API a été mise à jour pour inclure le type de travail dans le cadre du chemin d’accès, en remplaçant l’utilisation précédente d’un paramètre de requête. Pour la compatibilité descendante, les appels utilisant le paramètre de requête sont toujours pris en charge.

Étendues déléguées requises

Pour les API dataflows, utilisez ces types d’étendue :

  • Étendue spécifique : Dataflow.Execute.All

pour plus d’informations sur les étendues, consultez : article sur les étendues.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identity Support
User Yes
Service principal et identités gérées No

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/Execute/instances

Paramètres URI

Nom Dans Obligatoire Type Description
dataflowId
 path True

string (uuid)

ID de flux de données.
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.

Corps de la demande

Nom Type Description
executionData

DataflowExecutionPayload

Charge utile pour exécuter une demande de travail d’exécution à la demande. Nécessaire uniquement si le flux de données a activé le paramétrage.

Réponses

Nom Type Description
202 Accepted

Demande acceptée, l’exécution du travail est en cours.

En-têtes

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • InsufficientPrivileges : l’appelant ne dispose pas des autorisations suffisantes pour exécuter l’instance de travail.

  • InvalidJobType : le type de travail demandé n’est pas valide.

  • TooManyRequestsForJobs : l’appelant demande trop de demandes de travaux à la demande.

  • ItemNotFound - ID d’élément demandé introuvable.

Exemples

Run dataflow Execute job instance with no request body example
Run dataflow Execute job instance with request body containing parameters example

Run dataflow Execute job instance with no request body example

Exemple de requête

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/Execute/instances

Exemple de réponse

Code d’état:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc
Retry-After: 60

Run dataflow Execute job instance with request body containing parameters example

Exemple de requête

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/Execute/instances

{
  "executionData": {
    "executeOption": "ApplyChangesIfNeeded",
    "parameters": [
      {
        "parameterName": "OrderKey",
        "type": "Automatic",
        "value": 25
      },
      {
        "parameterName": "Threshold",
        "type": "Automatic",
        "value": "start"
      }
    ]
  }
}

Exemple de réponse

Code d’état:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc
Retry-After: 60

Définitions

Nom Description
DataflowExecutionPayload

Charge utile des données d’exécution pour dataflow
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
ExecuteOption

Options pour exécuter l’opération d’exécution. Des executeOptions supplémentaires peuvent être ajoutées au fil du temps.
ItemJobParameter

Détails du paramètre.
RunOnDemandDataflowExecuteJobRequest

Exécuter à la demande exécuter la charge utile de l’instance de travail de flux de données
Type

Type de paramètre. Des types de paramètres supplémentaires peuvent être ajoutés au fil du temps.

DataflowExecutionPayload

Objet

Charge utile des données d’exécution pour dataflow

Nom Type Description
executeOption

ExecuteOption

Options pour exécuter l’opération d’exécution. Des executeOptions supplémentaires peuvent être ajoutées au fil du temps.
parameters

ItemJobParameter[]

Liste des paramètres à remplacer pendant l’exécution.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

ExecuteOption

Énumération

Options pour exécuter l’opération d’exécution. Des executeOptions supplémentaires peuvent être ajoutées au fil du temps.

Valeur Description
SkipApplyChanges

Valeur par défaut. L’opération Appliquer les modifications est ignorée.
ApplyChangesIfNeeded

L’opération Modifications appply est effectuée si nécessaire. Peut être utilisé lorsque les dernières modifications sont requises pour Execute.

ItemJobParameter

Objet

Détails du paramètre.

Nom Type Description
parameterName

string

Nom du paramètre.
type

Type

Type de paramètre. Des types de paramètres supplémentaires peuvent être ajoutés au fil du temps.
value

Valeur du paramètre à remplacer pendant l’exécution.

RunOnDemandDataflowExecuteJobRequest

Objet

Exécuter à la demande exécuter la charge utile de l’instance de travail de flux de données

Nom Type Description
executionData

DataflowExecutionPayload

Charge utile pour exécuter une demande de travail d’exécution à la demande. Nécessaire uniquement si le flux de données a activé le paramétrage.

Type

Énumération

Type de paramètre. Des types de paramètres supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Automatic

La valeur doit être automatique