Pipeline Runs - Query By Factory

O gasoduto de consulta funciona na fábrica com base nas condições do filtro de entrada.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns?api-version=2018-06-01

Parâmetros do URI

Name In Required Type Description
factoryName
path True
  • string

O nome da fábrica.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True
  • string

O nome do grupo de recursos.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

O identificador de assinatura.

api-version
query True
  • string

A versão API.

Corpo do Pedido

Name Required Type Description
lastUpdatedAfter True
  • string

O tempo em ou após o qual o evento de corrida foi atualizado no formato 'ISO 8601'.

lastUpdatedBefore True
  • string

O tempo em ou antes do qual o evento de execução foi atualizado no formato 'ISO 8601'.

continuationToken
  • string

O símbolo de continuação para obter a próxima página de resultados. Nulo para primeira página.

filters

Lista de filtros.

orderBy

Lista de opções OrderBy.

Respostas

Name Type Description
200 OK

OK.

Other Status Codes

Uma resposta de erro recebida do serviço Azure Data Factory.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

PipelineRuns_QueryByFactory

Sample Request

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

Sample Response

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

Definições

CloudError

O objeto que define a estrutura de uma resposta de erro da Fábrica de Dados Azure.

PipelineRun

Informação sobre uma corrida ao oleoduto.

PipelineRunInvokedBy

Fornece o nome da entidade e id que iniciou a execução do gasoduto.

PipelineRunsQueryResponse

Um oleoduto de lista corre.

RunFilterParameters

Parâmetros de consulta para a listagem de corridas.

RunQueryFilter

Opção de filtro de consulta para listagem de executões.

RunQueryFilterOperand

Nome do parâmetro a utilizar para filtro. Os operands autorizados para consulta de gasodutos são PipelineName, RunStart, RunEnd e Status; para consulta de atividades executa são ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType e Status, e para consulta de executões de gatilho são TriggerName, TriggerRunTimestamp e Status.

RunQueryFilterOperator

Operador a utilizar para filtro.

RunQueryOrder

Ordem de classificação do parâmetro.

RunQueryOrderBy

Um objeto para fornecer a encomenda por opções para a listagem de execuções.

RunQueryOrderByField

Nome do parâmetro a ser usado para encomenda por. Os parâmetros permitidos para encomendar para as corridas de gasodutos são PipelineName, RunStart, RunEnd e Status; para os executamentos de atividade são ActivityName, ActivityRunStart, ActivityRunEnd e Status; para as execuções do gatilho são TriggerName, TriggerRunTimestamp e Status.

CloudError

O objeto que define a estrutura de uma resposta de erro da Fábrica de Dados Azure.

Name Type Description
error.code
  • string

Código de erro.

error.details

Matriz com detalhes adicionais de erro.

error.message
  • string

Mensagem de erro.

error.target
  • string

Nome/caminho de propriedade a pedido associado ao erro.

PipelineRun

Informação sobre uma corrida ao oleoduto.

Name Type Description
durationInMs
  • integer

A duração de um gasoduto.

invokedBy

Entidade que iniciou a execução do oleoduto.

isLatest
  • boolean

Indica se a execução do gasoduto recuperado é a mais recente do seu grupo.

lastUpdated
  • string

A última marca atualizada para o evento de execução do gasoduto no formato ISO8601.

message
  • string

A mensagem de um oleoduto.

parameters
  • object

A lista completa ou parcial do nome do parâmetro, par de valor utilizado na execução do gasoduto.

pipelineName
  • string

O nome do oleoduto.

runDimensions
  • object

Executar dimensões emitidas pela execução de Pipeline.

runEnd
  • string

O tempo final de um gasoduto executado em formato ISO8601.

runGroupId
  • string

Identificador que correlaciona todas as corridas de recuperação de um gasoduto.

runId
  • string

Identificador de uma corrida.

runStart
  • string

A hora de início de um gasoduto executado em formato ISO8601.

status
  • string

O estado de uma corrida de gasodutos.

PipelineRunInvokedBy

Fornece o nome da entidade e id que iniciou a execução do gasoduto.

Name Type Description
id
  • string

A identificação da entidade que iniciou a corrida.

invokedByType
  • string

O tipo de entidade que iniciou a corrida.

name
  • string

Nome da entidade que iniciou a execução do gasoduto.

PipelineRunsQueryResponse

Um oleoduto de lista corre.

Name Type Description
continuationToken
  • string

O símbolo de continuação para obter a próxima página de resultados, se houver algum resultado restante, nulo de outra forma.

value

Lista de gasodutos.

RunFilterParameters

Parâmetros de consulta para a listagem de corridas.

Name Type Description
continuationToken
  • string

O símbolo de continuação para obter a próxima página de resultados. Nulo para primeira página.

filters

Lista de filtros.

lastUpdatedAfter
  • string

O tempo em ou após o qual o evento de corrida foi atualizado no formato 'ISO 8601'.

lastUpdatedBefore
  • string

O tempo em ou antes do qual o evento de execução foi atualizado no formato 'ISO 8601'.

orderBy

Lista de opções OrderBy.

RunQueryFilter

Opção de filtro de consulta para listagem de executões.

Name Type Description
operand

Nome do parâmetro a utilizar para filtro. Os operands autorizados para consulta de gasodutos são PipelineName, RunStart, RunEnd e Status; para consulta de atividades executa são ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType e Status, e para consulta de executões de gatilho são TriggerName, TriggerRunTimestamp e Status.

operator

Operador a utilizar para filtro.

values
  • string[]

Lista de valores de filtro.

RunQueryFilterOperand

Nome do parâmetro a utilizar para filtro. Os operands autorizados para consulta de gasodutos são PipelineName, RunStart, RunEnd e Status; para consulta de atividades executa são ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType e Status, e para consulta de executões de gatilho são TriggerName, TriggerRunTimestamp e 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

Operador a utilizar para filtro.

Name Type Description
Equals
  • string
In
  • string
NotEquals
  • string
NotIn
  • string

RunQueryOrder

Ordem de classificação do parâmetro.

Name Type Description
ASC
  • string
DESC
  • string

RunQueryOrderBy

Um objeto para fornecer a encomenda por opções para a listagem de execuções.

Name Type Description
order

Ordem de classificação do parâmetro.

orderBy

Nome do parâmetro a ser usado para encomenda por. Os parâmetros permitidos para encomendar para as corridas de gasodutos são PipelineName, RunStart, RunEnd e Status; para os executamentos de atividade são ActivityName, ActivityRunStart, ActivityRunEnd e Status; para as execuções do gatilho são TriggerName, TriggerRunTimestamp e Status.

RunQueryOrderByField

Nome do parâmetro a ser usado para encomenda por. Os parâmetros permitidos para encomendar para as corridas de gasodutos são PipelineName, RunStart, RunEnd e Status; para os executamentos de atividade são ActivityName, ActivityRunStart, ActivityRunEnd e Status; para as execuções do gatilho são TriggerName, TriggerRunTimestamp e Status.

Name Type Description
ActivityName
  • string
ActivityRunEnd
  • string
ActivityRunStart
  • string
PipelineName
  • string
RunEnd
  • string
RunStart
  • string
Status
  • string
TriggerName
  • string
TriggerRunTimestamp
  • string