Freigeben über

Background Jobs - Run On Demand Execute

Dienst:
Dataflow
API-Version:
v1

Ausführen einer Auftragsinstanz bei Bedarf.

Note

Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen. Die URL für diese API wurde aktualisiert, um den Auftragstyp als Teil des Pfads einzuschließen, wobei die vorherige Verwendung eines Abfrageparameters ersetzt wird. Aus Gründen der Abwärtskompatibilität werden Aufrufe mit dem Abfrageparameter weiterhin unterstützt.

Erforderliche delegierte Bereiche

Verwenden Sie für Datenflüsse-APIs die folgenden Bereichstypen:

  • Spezifischer Bereich: Dataflow.Execute.All

weitere Informationen zu Bereichen finden Sie im Artikel " Bereiche".

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity Support
User Yes
Service Principal und Verwaltete Identitäten No

Interface

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
dataflowId
 path True

string (uuid)

Die Datenfluss-ID.
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.

Anforderungstext

Name Typ Beschreibung
executionData

DataflowExecutionPayload

Nutzlast für ausführungsbasierte Ausführungsauftragsanforderung. Wird nur benötigt, wenn der Datenfluss die Parameterisierung aktiviert hat.

Antworten

Name Typ Beschreibung
202 Accepted

Anforderung angenommen, Auftragsausführung wird ausgeführt.

Header

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

ErrorResponse

Häufige Fehlercodes:

  • InsufficientPrivileges – Der Aufrufer verfügt nicht über ausreichende Berechtigungen zum Ausführen der Auftragsinstanz.

  • InvalidJobType – Der angeforderte Auftragstyp ist ungültig.

  • TooManyRequestsForJobs – Der Aufrufer fordert zu viele On-Demand-Auftragsanforderungen an.

  • ItemNotFound – Angeforderte Element-ID nicht gefunden.

Beispiele

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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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"
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:
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

Definitionen

Name Beschreibung
DataflowExecutionPayload

Die Ausführungsdatennutzlast für Dataflow
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
ExecuteOption

Optionen zum Ausführen des Ausführungsvorgangs. Zusätzliche executeOptions können im Laufe der Zeit hinzugefügt werden.
ItemJobParameter

Parameterdetails.
RunOnDemandDataflowExecuteJobRequest

Ausführen der Datenflussauftragsinstanznutzlast bei Bedarf ausführen
Type

Der Parametertyp. Zusätzliche Parametertypen können im Laufe der Zeit hinzugefügt werden.

DataflowExecutionPayload

Objekt

Die Ausführungsdatennutzlast für Dataflow

Name Typ Beschreibung
executeOption

ExecuteOption

Optionen zum Ausführen des Ausführungsvorgangs. Zusätzliche executeOptions können im Laufe der Zeit hinzugefügt werden.
parameters

ItemJobParameter[]

Eine Liste der Parameter, die während der Ausführung außer Kraft setzen sollen.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

ExecuteOption

Enumeration

Optionen zum Ausführen des Ausführungsvorgangs. Zusätzliche executeOptions können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
SkipApplyChanges

Standardwert. Der Vorgang "Änderungen anwenden" wird übersprungen.
ApplyChangesIfNeeded

Der Vorgang "Appply Changes" wird bei Bedarf ausgeführt. Kann verwendet werden, wenn die neuesten Änderungen für Execute erforderlich sind.

ItemJobParameter

Objekt

Parameterdetails.

Name Typ Beschreibung
parameterName

string

Name des Parameters.
type

Type

Der Parametertyp. Zusätzliche Parametertypen können im Laufe der Zeit hinzugefügt werden.
value

Der Wert des Parameters, der während der Ausführung außer Kraft setzen soll.

RunOnDemandDataflowExecuteJobRequest

Objekt

Ausführen der Datenflussauftragsinstanznutzlast bei Bedarf ausführen

Name Typ Beschreibung
executionData

DataflowExecutionPayload

Nutzlast für ausführungsbasierte Ausführungsauftragsanforderung. Wird nur benötigt, wenn der Datenfluss die Parameterisierung aktiviert hat.

Type

Enumeration

Der Parametertyp. Zusätzliche Parametertypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Automatic

Der Wert muss automatisch sein.