Trigger - Get Triggers By Workspace

Dienst:

Synapse

API-Version:

2020-12-01

Listen Trigger.

GET {endpoint}/triggers?api-version=2020-12-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Endpunkt zur Arbeitsbereichsentwicklung, Beispiel: https://myworkspace.dev.azuresynapse.net
api-version	query	True	string	Die Version der Synapse-Client-API.

Antworten

Name	Typ	Beschreibung
200 OK	TriggerListResponse	OK.
Other Status Codes	CloudError	Eine Vom Azure Synapse-Dienst empfangene Fehlerantwort.

Beispiele

Triggers_ListByWorkspace

Beispielanforderung

HTTP

GET exampleWorkspace.dev.azuresynapse.net/triggers?api-version=2020-12-01

Beispiel für eine Antwort

Statuscode:

200

Date: Sat, 16 Jun 2018 00:40:20 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14986
x-ms-request-id: e474f8f8-b34f-4536-b059-ca740e6b44c3
x-ms-correlation-request-id: e474f8f8-b34f-4536-b059-ca740e6b44c3

{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger",
      "name": "exampleTrigger",
      "type": "Microsoft.Synapse/workspaces/triggers",
      "properties": {
        "type": "ScheduleTrigger",
        "typeProperties": {
          "recurrence": {
            "frequency": "Minute",
            "interval": 4,
            "startTime": "2018-06-16T00:39:14.905167Z",
            "endTime": "2018-06-16T00:55:14.905167Z",
            "timeZone": "UTC"
          }
        },
        "pipelines": [
          {
            "pipelineReference": {
              "referenceName": "examplePipeline",
              "type": "PipelineReference"
            },
            "parameters": {
              "OutputBlobNameList": [
                "exampleoutput.csv"
              ]
            }
          }
        ],
        "description": "Example description",
        "runtimeState": "Started"
      },
      "etag": "0a008ed4-0000-0000-0000-5b245c740000"
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Das -Objekt, das die Struktur einer Azure Synapse Fehlerantwort definiert.
MultiplePipelineTrigger	Basisklasse für alle Trigger, die eins:n-Modell für trigger to pipeline unterstützen.
PipelineReference	Pipelineverweistyp.
PipelineReferenceType	Pipelineverweistyp.
TriggerListResponse	Eine Liste der Triggerressourcen.
TriggerPipelineReference	Pipeline, die mit den angegebenen Parametern ausgelöst werden muss.
TriggerResource	Triggerressourcentyp.
TriggerRuntimeState	Listet den möglichen Status von Triggern auf.

CloudError

Objekt

Das -Objekt, das die Struktur einer Azure Synapse Fehlerantwort definiert.

Name	Typ	Beschreibung
error.code	string	Fehlercode
error.details	CloudError[]	Array mit zusätzlichen Fehlerdetails.
error.message	string	Fehlermeldung.
error.target	string	Eigenschaftsname/Pfad in der Anforderung, die einem Fehler zugeordnet ist.

MultiplePipelineTrigger

Objekt

Basisklasse für alle Trigger, die eins:n-Modell für trigger to pipeline unterstützen.

Name	Typ	Beschreibung
annotations	object[]	Liste der Tags, die zum Beschreiben des Triggers verwendet werden können.
description	string	Triggerbeschreibung.
pipelines	TriggerPipelineReference[]	Pipelines, die gestartet werden müssen.
runtimeState	TriggerRuntimeState	Gibt an, ob der Trigger ausgeführt wird oder nicht. Aktualisiert, wenn Start/Stop-APIs für den Trigger aufgerufen werden.
type	string: MultiplePipelineTrigger	Der Triggertyp,

PipelineReference

Objekt

Pipelineverweistyp.

Name	Typ	Beschreibung
name	string	Verweisname.
referenceName	string	Referenzpipelinename.
type	PipelineReferenceType	Pipelineverweistyp.

PipelineReferenceType

Enumeration

Pipelineverweistyp.

Wert	Beschreibung
PipelineReference

TriggerListResponse

Objekt

Eine Liste der Triggerressourcen.

Name	Typ	Beschreibung
nextLink	string	Der Link zur nächsten Seite der Ergebnisse, wenn noch ergebnisse vorhanden sind.
value	TriggerResource[]	Liste der Trigger.

TriggerPipelineReference

Objekt

Pipeline, die mit den angegebenen Parametern ausgelöst werden muss.

Name	Typ	Beschreibung
parameters	object	Pipelineparameter
pipelineReference	PipelineReference	Pipelinereferenz.

TriggerResource

Objekt

Triggerressourcentyp.

Name	Typ	Beschreibung
etag	string	Ressourcen-Etag.
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties	Trigger: MultiplePipelineTrigger	Eigenschaften des Triggers.
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

TriggerRuntimeState

Enumeration

Listet den möglichen Status von Triggern auf.

Wert	Beschreibung
Disabled
Started
Stopped