Pipeline Runs - Query By Factory
Querypijplijn wordt uitgevoerd in de fabriek op basis van invoerfiltervoorwaarden.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns?api-version=2018-06-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
factory
|
path | True |
string |
De fabrieksnaam. Regex-patroon: |
resource
|
path | True |
string |
De naam van de resourcegroep. Regex-patroon: |
subscription
|
path | True |
string |
De abonnements-id. |
api-version
|
query | True |
string |
De API-versie. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
lastUpdatedAfter | True |
string |
De tijd op of waarna de uitvoeringsgebeurtenis is bijgewerkt in iso 8601-indeling. |
lastUpdatedBefore | True |
string |
De tijd op of waarvoor de uitvoeringsgebeurtenis is bijgewerkt in de indeling 'ISO 8601'. |
continuationToken |
string |
Het vervolgtoken voor het ophalen van de volgende pagina met resultaten. Null voor eerste pagina. |
|
filters |
Lijst met filters. |
||
orderBy |
Lijst met de optie OrderBy. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
Een foutbericht ontvangen van de Azure Data Factory-service. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | uw gebruikersaccount imiteren |
Voorbeelden
PipelineRuns_QueryByFactory
Voorbeeldaanvraag
POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/queryPipelineRuns?api-version=2018-06-01
{
"lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
"lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z",
"filters": [
{
"operand": "PipelineName",
"operator": "Equals",
"values": [
"examplePipeline"
]
}
]
}
Voorbeeldrespons
Date: Sat, 16 Jun 2018 00:40:01 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14989
x-ms-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd
x-ms-correlation-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd
{
"value": [
{
"runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
"pipelineName": "examplePipeline",
"parameters": {
"OutputBlobNameList": "[\"exampleoutput.csv\"]"
},
"invokedBy": {
"id": "80a01654a9d34ad18b3fcac5d5d76b67",
"name": "Manual"
},
"runStart": "2018-06-16T00:37:44.6257014Z",
"runEnd": "2018-06-16T00:38:12.7314495Z",
"durationInMs": 28105,
"status": "Succeeded",
"message": "",
"lastUpdated": "2018-06-16T00:38:12.7314495Z",
"annotations": [],
"runDimension": {
"JobId": "79c1cc52-265f-41a5-9553-be65e736fbd3"
}
},
{
"runId": "16ac5348-ff82-4f95-a80d-638c1d47b721",
"pipelineName": "examplePipeline",
"parameters": {
"OutputBlobNameList": "[\"exampleoutput.csv\"]"
},
"invokedBy": {
"id": "7c5fd7ef7e8a464b98b931cf15fcac66",
"name": "Manual"
},
"runStart": "2018-06-16T00:39:49.2745128Z",
"runEnd": null,
"durationInMs": null,
"status": "Cancelled",
"message": "",
"lastUpdated": "2018-06-16T00:39:51.216097Z",
"annotations": [],
"runDimension": {
"JobId": "84a3c493-0628-4b44-852f-ef5b3a11bdab"
}
}
]
}
Definities
Name | Description |
---|---|
Cloud |
Het object dat de structuur van een Azure Data Factory foutreactie definieert. |
Pipeline |
Informatie over een pijplijnuitvoering. |
Pipeline |
Geeft de naam en id van de entiteit op waarmee de pijplijnuitvoering is gestart. |
Pipeline |
Er wordt een lijstpijplijn uitgevoerd. |
Run |
Queryparameters voor het weergeven van uitvoeringen. |
Run |
Queryfilteroptie voor het weergeven van uitvoeringen. |
Run |
Parameternaam die moet worden gebruikt voor het filter. De toegestane operands voor het uitvoeren van query's op pijplijnuitvoeringen zijn PipelineName, RunStart, RunEnd en Status; uitvoeringen van queryactiviteit zijn ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType en Status, en voor querytriggeruitvoeringen zijn TriggerName, TriggerRunTimestamp en Status. |
Run |
Operator die moet worden gebruikt voor het filter. |
Run |
Sorteervolgorde van de parameter. |
Run |
Een object voor het opgeven van volgordeopties voor het weergeven van uitvoeringen. |
Run |
Parameternaam die moet worden gebruikt voor order by. De toegestane parameters voor pijplijnuitvoeringen zijn PipelineName, RunStart, RunEnd en Status; voor activiteitsuitvoeringen zijn ActivityName, ActivityRunStart, ActivityRunEnd en Status; voor triggeruitvoeringen zijn TriggerName, TriggerRunTimestamp en Status. |
CloudError
Het object dat de structuur van een Azure Data Factory foutreactie definieert.
Name | Type | Description |
---|---|---|
error.code |
string |
Foutcode. |
error.details |
Matrix met aanvullende foutdetails. |
|
error.message |
string |
Foutbericht. |
error.target |
string |
De naam/het pad van de eigenschap in de aanvraag die is gekoppeld aan een fout. |
PipelineRun
Informatie over een pijplijnuitvoering.
Name | Type | Description |
---|---|---|
durationInMs |
integer |
De duur van een pijplijnuitvoering. |
invokedBy |
Entiteit waarmee de pijplijnuitvoering is gestart. |
|
isLatest |
boolean |
Geeft aan of de herstelde pijplijnuitvoering de meest recente in de groep is. |
lastUpdated |
string |
Het laatst bijgewerkte tijdstempel voor de gebeurtenis voor het uitvoeren van de pijplijn in ISO8601 indeling. |
message |
string |
Het bericht van een pijplijnuitvoering. |
parameters |
object |
De volledige of gedeeltelijke lijst met parameternaam, waardepaar dat wordt gebruikt in de pijplijnuitvoering. |
pipelineName |
string |
De naam van de pijplijn. |
runDimensions |
object |
Uitvoeringsdimensies die worden verzonden door pijplijnuitvoering. |
runEnd |
string |
De eindtijd van een pijplijnuitvoering in ISO8601 indeling. |
runGroupId |
string |
Id die alle hersteluitvoeringen van een pijplijnuitvoering correleert. |
runId |
string |
Id van een uitvoering. |
runStart |
string |
De begintijd van een pijplijnuitvoering in ISO8601 indeling. |
status |
string |
De status van een pijplijnuitvoering. Mogelijke waarden: In wachtrij, Inprogress, Geslaagd, Mislukt, Annuleren, Geannuleerd |
PipelineRunInvokedBy
Geeft de naam en id van de entiteit op waarmee de pijplijnuitvoering is gestart.
Name | Type | Description |
---|---|---|
id |
string |
De id van de entiteit die de uitvoering heeft gestart. |
invokedByType |
string |
Het type entiteit waarmee de uitvoering is gestart. |
name |
string |
Naam van de entiteit waarmee de pijplijnuitvoering is gestart. |
pipelineName |
string |
De naam van de pijplijn die de uitvoering heeft geactiveerd, indien van toepassing. |
pipelineRunId |
string |
De uitvoerings-id van de pijplijn die de uitvoering heeft geactiveerd, indien van toepassing. |
PipelineRunsQueryResponse
Er wordt een lijstpijplijn uitgevoerd.
Name | Type | Description |
---|---|---|
continuationToken |
string |
Het vervolgtoken voor het ophalen van de volgende pagina met resultaten, als er nog resultaten bestaan, anders null. |
value |
Lijst met pijplijnuitvoeringen. |
RunFilterParameters
Queryparameters voor het weergeven van uitvoeringen.
Name | Type | Description |
---|---|---|
continuationToken |
string |
Het vervolgtoken voor het ophalen van de volgende pagina met resultaten. Null voor eerste pagina. |
filters |
Lijst met filters. |
|
lastUpdatedAfter |
string |
De tijd op of waarna de uitvoeringsgebeurtenis is bijgewerkt in iso 8601-indeling. |
lastUpdatedBefore |
string |
De tijd op of waarvoor de uitvoeringsgebeurtenis is bijgewerkt in de indeling 'ISO 8601'. |
orderBy |
Lijst met de optie OrderBy. |
RunQueryFilter
Queryfilteroptie voor het weergeven van uitvoeringen.
Name | Type | Description |
---|---|---|
operand |
Parameternaam die moet worden gebruikt voor het filter. De toegestane operands voor het uitvoeren van query's op pijplijnuitvoeringen zijn PipelineName, RunStart, RunEnd en Status; uitvoeringen van queryactiviteit zijn ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType en Status, en voor querytriggeruitvoeringen zijn TriggerName, TriggerRunTimestamp en Status. |
|
operator |
Operator die moet worden gebruikt voor het filter. |
|
values |
string[] |
Lijst met filterwaarden. |
RunQueryFilterOperand
Parameternaam die moet worden gebruikt voor het filter. De toegestane operands voor het uitvoeren van query's op pijplijnuitvoeringen zijn PipelineName, RunStart, RunEnd en Status; uitvoeringen van queryactiviteit zijn ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType en Status, en voor querytriggeruitvoeringen zijn TriggerName, TriggerRunTimestamp en Status.
Name | Type | Description |
---|---|---|
ActivityName |
string |
|
ActivityRunEnd |
string |
|
ActivityRunStart |
string |
|
ActivityType |
string |
|
LatestOnly |
string |
|
PipelineName |
string |
|
RunEnd |
string |
|
RunGroupId |
string |
|
RunStart |
string |
|
Status |
string |
|
TriggerName |
string |
|
TriggerRunTimestamp |
string |
RunQueryFilterOperator
Operator die moet worden gebruikt voor het filter.
Name | Type | Description |
---|---|---|
Equals |
string |
|
In |
string |
|
NotEquals |
string |
|
NotIn |
string |
RunQueryOrder
Sorteervolgorde van de parameter.
Name | Type | Description |
---|---|---|
ASC |
string |
|
DESC |
string |
RunQueryOrderBy
Een object voor het opgeven van volgordeopties voor het weergeven van uitvoeringen.
Name | Type | Description |
---|---|---|
order |
Sorteervolgorde van de parameter. |
|
orderBy |
Parameternaam die moet worden gebruikt voor order by. De toegestane parameters voor pijplijnuitvoeringen zijn PipelineName, RunStart, RunEnd en Status; voor activiteitsuitvoeringen zijn ActivityName, ActivityRunStart, ActivityRunEnd en Status; voor triggeruitvoeringen zijn TriggerName, TriggerRunTimestamp en Status. |
RunQueryOrderByField
Parameternaam die moet worden gebruikt voor order by. De toegestane parameters voor pijplijnuitvoeringen zijn PipelineName, RunStart, RunEnd en Status; voor activiteitsuitvoeringen zijn ActivityName, ActivityRunStart, ActivityRunEnd en Status; voor triggeruitvoeringen zijn TriggerName, TriggerRunTimestamp en Status.
Name | Type | Description |
---|---|---|
ActivityName |
string |
|
ActivityRunEnd |
string |
|
ActivityRunStart |
string |
|
PipelineName |
string |
|
RunEnd |
string |
|
RunStart |
string |
|
Status |
string |
|
TriggerName |
string |
|
TriggerRunTimestamp |
string |