Trigger - Get Triggers By Workspace

Szolgáltatás:

Synapse

API-verzió:

2020-12-01

Az eseményindítók listája.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A munkaterület fejlesztési végpontja, például https://myworkspace.dev.azuresynapse.net.
api-version	query	True	string	A Synapse ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	TriggerListResponse	OKÉ.
Other Status Codes	CloudError	Hibaválasz érkezett az Azure Synapse szolgáltatástól.

Példák

Triggers_ListByWorkspace

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
CloudError	Az Azure Synapse-hibaválasz szerkezetét meghatározó objektum.
MultiplePipelineTrigger	Alaposztály minden olyan eseményindítóhoz, amely egy-több modellt támogat a folyamatindításhoz.
PipelineReference	Folyamathivatkozás típusa.
PipelineReferenceType	Folyamathivatkozás típusa.
TriggerListResponse	A triggererőforrások listája.
TriggerPipelineReference	A megadott paraméterekkel aktiválandó folyamat.
TriggerResource	Erőforrástípus aktiválása.
TriggerRuntimeState	Az eseményindítók lehetséges állapotának számbavétele.

CloudError

Objektum

Az Azure Synapse-hibaválasz szerkezetét meghatározó objektum.

Name	Típus	Description
error.code	string	Hibakód.
error.details	CloudError[]	Tömb további hibaadatokkal.
error.message	string	Hibaüzenet.
error.target	string	A kérelemben szereplő tulajdonság neve/elérési útja hibával van társítva.

MultiplePipelineTrigger

Objektum

Alaposztály minden olyan eseményindítóhoz, amely egy-több modellt támogat a folyamatindításhoz.

Name	Típus	Description
annotations	object[]	Az eseményindító leírásához használható címkék listája.
description	string	Eseményindító leírása.
pipelines	TriggerPipelineReference[]	Azokat a folyamatokat, amelyeket el kell indítani.
runtimeState	TriggerRuntimeState	Azt jelzi, hogy az eseményindító fut-e vagy sem. Frissült, amikor a rendszer meghívja a Start/Stop API-kat az eseményindítón.
type	string: MultiplePipelineTrigger	Eseményindító típusa.

PipelineReference

Objektum

Folyamathivatkozás típusa.

Name	Típus	Description
name	string	Hivatkozás neve.
referenceName	string	Referenciafolyamat neve.
type	PipelineReferenceType	Folyamathivatkozás típusa.

PipelineReferenceType

Enumerálás

Folyamathivatkozás típusa.

Érték	Description
PipelineReference

TriggerListResponse

Objektum

A triggererőforrások listája.

Name	Típus	Description
nextLink	string	Az eredmények következő oldalára mutató hivatkozás, ha vannak még találatok.
value	TriggerResource[]	Eseményindítók listája.

TriggerPipelineReference

Objektum

A megadott paraméterekkel aktiválandó folyamat.

Name	Típus	Description
parameters	object	Folyamatparaméterek.
pipelineReference	PipelineReference	Folyamathivatkozás.

TriggerResource

Objektum

Erőforrástípus aktiválása.

Name	Típus	Description
etag	string	Erőforráscímke.
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties	Trigger: MultiplePipelineTrigger	Az eseményindító tulajdonságai.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

TriggerRuntimeState

Enumerálás

Az eseményindítók lehetséges állapotának számbavétele.

Érték	Description
Started
Stopped
Disabled