Recursos de APIs públicas para Dataflows Gen2 no Fabric Data Factory (Visualização)

2025-05-19

Observação

A API do Microsoft Fabric para Data Factory está atualmente em visualização pública. Estas informações referem-se a um produto de pré-lançamento que pode ser substancialmente modificado antes de ser lançado. A Microsoft não oferece garantias, expressas ou implícitas, em relação às informações fornecidas aqui.

O Fabric Data Factory fornece um conjunto robusto de APIs que permitem aos usuários automatizar e gerenciar seus fluxos de dados de forma eficiente. Essas APIs permitem uma integração perfeita com várias fontes de dados e serviços, permitindo que os usuários criem, atualizem e monitorem seus fluxos de trabalho de dados programaticamente. As APIs suportam uma ampla gama de operações, incluindo fluxos de dados CRUD (Criar, Ler, Atualizar e Excluir), agendamento e monitoramento, tornando mais fácil para os usuários gerenciar seus processos de integração de dados.

Casos de uso de APIs para fluxos de dados

As APIs para fluxos de dados no Fabric Data Factory podem ser usadas em vários cenários:

Implantação automatizada: automatize a implantação de fluxos de dados em diferentes ambientes (desenvolvimento, testes, produção) usando práticas de CI/CD.
Monitoramento e alertas: configure sistemas automatizados de monitoramento e alerta para acompanhar o status dos fluxos de dados e receber notificações em caso de falhas ou problemas de desempenho.
Integração de dados: integre dados de várias fontes, como bancos de dados, data lakes e serviços em nuvem, em um fluxo de dados unificado para processamento e análise.
Tratamento de erros: implemente mecanismos personalizados de tratamento de erros e novas tentativas para garantir que os fluxos de dados funcionem sem problemas e se recuperem de falhas.

Noções básicas sobre APIs

Para usar efetivamente as APIs para fluxos de dados no Fabric Data Factory, é essencial entender os principais conceitos e componentes:

Pontos de extremidade: os pontos de extremidade da API fornecem acesso a várias operações de fluxo de dados, como criação, atualização e exclusão de fluxos de dados.
Autenticação: acesso seguro às APIs usando mecanismos de autenticação como OAuth ou chaves de API.
Solicitações e respostas: entenda a estrutura das solicitações e respostas da API, incluindo os parâmetros necessários e a saída esperada.
Limites de taxa: esteja ciente dos limites de taxa impostos ao uso da API para evitar exceder o número permitido de solicitações.

Suporte CRUD

CRUD significa Criar, Ler, Atualizar e Excluir, que são as quatro operações básicas que podem ser executadas em dados. No Fabric Data Factory, as operações CRUD são suportadas por meio da API de malha para Data Factory, que está atualmente em visualização. Essas APIs permitem que os usuários gerenciem seus fluxos de dados programaticamente. Aqui estão alguns pontos-chave sobre o suporte CRUD:

Criar: crie novos fluxos de dados usando a API. Isso envolve definir a estrutura do fluxo de dados, especificando fontes de dados, transformações e destinos.
Leia: Recupere informações sobre fluxos de dados existentes. Isso inclui detalhes sobre sua configuração, status e histórico de execução.
Atualizar: atualize os fluxos de dados existentes. Isso pode envolver a modificação da estrutura de fluxo de dados, a alteração de fontes de dados ou a atualização da lógica de transformação.
Excluir: exclua fluxos de dados que não são mais necessários. Isso ajuda na gestão e limpeza de recursos.

A principal documentação de referência online para APIs REST do Microsoft Fabric pode ser encontrada na documentação da API REST do Microsoft Fabric.

Ciclo de vida do fluxo de dados

Ao trabalhar com fluxos de dados, é importante entender o ciclo de vida de um fluxo de dados para garantir processos de integração de dados suaves e eficientes. Os principais estágios do ciclo de vida do fluxo de dados incluem:

Definição: Este é o estágio inicial em que você cria ou modifica a definição de um fluxo de dados. Isso envolve especificar as fontes de dados, transformações e definições.
Publicar: Depois de modificar a definição de um fluxo de dados, você precisa invocar a operação Publicar . Esta é uma etapa crucial, pois salva as alterações feitas na definição do fluxo de dados e o torna disponível para execução.
Atualizar: Depois que o fluxo de dados for publicado, você poderá invocar a operação Atualizar . Isso aciona a execução do fluxo de dados, extraindo dados das fontes especificadas, aplicando as transformações definidas e carregando os dados no destino.

Introdução às APIs públicas para fluxos de dados

Nesta seção, abordamos todos os seguintes tópicos:

Obter um token de autorização
Criar um fluxo de dados
Criar um fluxo de dados com definição
Obter fluxo de dados
Obter fluxo de dados com definição
Atualizar fluxo de dados
Atualizar fluxo de dados com definição
Excluir fluxo de dados
Executar trabalho de fluxo de dados a pedido (atualizar)
Executar trabalho de publicação de fluxo de dados a pedido
Obter instância de trabalho Dataflow
Cancelar instância de tarefa de fluxo de dados

Obter um token de autorização

Você precisará ter o token de portador para todas as chamadas de API REST e pode obtê-lo usando uma destas opções:

MSAL.Net
Portal de Tecido

MSAL.Net

Guia de início rápido da API do Fabric - APIs REST do Microsoft Fabric

Utilize MSAL.Net para adquirir um token de ID do Microsoft Entra para o serviço Fabric com os seguintes âmbitos: Workspace.ReadWrite.All, Item.ReadWrite.All. Para obter mais informações sobre a aquisição de tokens com MSAL.Net, consulte Aquisição de Token - Biblioteca de Autenticação da Microsoft para .NET.

Cole o ID do aplicativo (cliente) copiado anteriormente e cole-o para a variável ClientId.

Portal de Tecido

Entre no Fabric Portal para o inquilino que deseja testar e pressione F12 para entrar no modo de desenvolvedor do navegador. Na consola, corra:

powerBIAccessToken

Copie o token e cole-o para a variável ClientId.

Criar um fluxo de dados

Crie um fluxo de dados em um espaço de trabalho especificado.

Pedido de amostra

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items)

Headers:

{
    "Authorization": "\<bearer-token>",
    "Content-Type": "application/json"
}

Payload:

{
    "displayName": "My dataflow",
    "description": "My dataflow description",
    "type": "Dataflow"
}

Exemplo de resposta

{
    "id": "\<artifactId>",
    "type": "Dataflow",
    "displayName": "My dataflow",
    "description": "My dataflow description",
    "workspaceId": "\<workspaceId>"
}

Criar um fluxo de dados com definição

Crie um fluxo de dados com uma definição base64 em um espaço de trabalho especificado.

Exemplo de documento de mashup

{
    "editingSessionMashup": {
            "mashupName": "",
            "mashupDocument": "section Section1;\r\nshared Query = let\n Source = Table.FromRows(\n {\n {1, \"Bob\", \"123-4567\"},\n {2, \"Jim\", \"987-6543\"}\n },\n {\"CustomerID\", \"Name\", \"Phone\"})\nin\n Source;\r\n",
            "queryGroups": [],
            "documentLocale": "en-US",
            "gatewayObjectId": null,
            "queriesMetadata": null,
            "connectionOverrides": [],
            "trustedConnections": null,
            "useHostConnectionProvider": false,
            "fastCombine": false,
            "allowNativeQueries": true,
            "allowedModules": null,
            "skipAutomaticTypeAndHeaderDetection": false,
            "disableAutoAnonymousConnectionUpsert": null,
            "hostProperties": {
                    "DataflowRefreshOutputFileFormat": "Parquet",
                    "EnableDateTimeFieldsForStaging": "true",
                    "EnablePublishWithoutLoadedQueries": "true"
            },
            "defaultOutputDestinationConfiguration": null,
            "stagingDefinition": null
    }
}

Use Base64 Encode and Decode para codificar seu JSON.

Verifique se a caixa Executar codificação segura de URL não está marcada.

Cole a resposta do seu pedido codificado em Base64 na definição da carga.

Pedido de amostra

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items)

Headers:

{
    "Authorization": "\<bearer-token>",
    "Content-Type": "application/json"
}

Payload:

{
    "displayName": " My dataflow",
    "description": "My dataflow description",

    "type": "Dataflow",
    "definition": {  
        "parts": [  
            {  
                "path": "dataflow-content.json",  
                "payload": "ewogICAgImVkaXRpbmdTZXNzaW9uTWFzaHVwIjogewogICAgICAgICJtYXNodXBOYW1lIjogIiIsCiAgICAgICAgIm1hc2h1cERvY3VtZW50IjogInNlY3Rpb24gU2VjdGlvbjE7XHJcbnNoYXJlZCBRdWVyeSA9IGxldFxuIFNvdXJjZSA9IFRhYmxlLkZyb21Sb3dzKFxuIHtcbiB7MSwgXCJCb2JcIiwgXCIxMjMtNDU2N1wifSxcbiB7MiwgXCJKaW1cIiwgXCI5ODctNjU0M1wifVxuIH0sXG4ge1wiQ3VzdG9tZXJJRFwiLCBcIk5hbWVcIiwgXCJQaG9uZVwifSlcbmluXG4gU291cmNlO1xyXG4iLAogICAgICAgICJxdWVyeUdyb3VwcyI6IFtdLAogICAgICAgICJkb2N1bWVudExvY2FsZSI6ICJlbi1VUyIsCiAgICAgICAgImdhdGV3YXlPYmplY3RJZCI6IG51bGwsCiAgICAgICAgInF1ZXJpZXNNZXRhZGF0YSI6IG51bGwsCiAgICAgICAgImNvbm5lY3Rpb25PdmVycmlkZXMiOiBbXSwKICAgICAgICAidHJ1c3RlZENvbm5lY3Rpb25zIjogbnVsbCwKICAgICAgICAidXNlSG9zdENvbm5lY3Rpb25Qcm92aWRlciI6IGZhbHNlLAogICAgICAgICJmYXN0Q29tYmluZSI6IGZhbHNlLAogICAgICAgICJhbGxvd05hdGl2ZVF1ZXJpZXMiOiB0cnVlLAogICAgICAgICJhbGxvd2VkTW9kdWxlcyI6IG51bGwsCiAgICAgICAgInNraXBBdXRvbWF0aWNUeXBlQW5kSGVhZGVyRGV0ZWN0aW9uIjogZmFsc2UsCiAgICAgICAgImRpc2FibGVBdXRvQW5vbnltb3VzQ29ubmVjdGlvblVwc2VydCI6IG51bGwsCiAgICAgICAgImhvc3RQcm9wZXJ0aWVzIjogewogICAgICAgICAgICAiRGF0YWZsb3dSZWZyZXNoT3V0cHV0RmlsZUZvcm1hdCI6ICJQYXJxdWV0IiwKICAgICAgICAgICAgIkVuYWJsZURhdGVUaW1lRmllbGRzRm9yU3RhZ2luZyI6ICJ0cnVlIiwKICAgICAgICAgICAgIkVuYWJsZVB1Ymxpc2hXaXRob3V0TG9hZGVkUXVlcmllcyI6ICJ0cnVlIgogICAgICAgIH0sCiAgICAgICAgImRlZmF1bHRPdXRwdXREZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb24iOiBudWxsLAogICAgICAgICJzdGFnaW5nRGVmaW5pdGlvbiI6IG51bGwKICAgIH0KfQ==",
                "payloadType": "InlineBase64"  
            }  
        ]  
    }  
}

Exemplo de resposta

{
    "id": "\<artifactId>",
    "type": "Dataflow",
    "displayName": "My dataflow",
    "description": "My dataflow description",
    "workspaceId": "\<workspaceId>"
}

Obter fluxo de dados

Retorna propriedades de fluxo de dados especificado.

Pedido de amostra

URI: GET [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d)

Headers:

{
    "Authorization": "\<bearer-token>"
}

Exemplo de resposta

{
    "id": "\<artifactId>",
    "type": "Dataflow",
    "displayName": "My dataflow",
    "description": "My dataflow description",
    "workspaceId": "\<workspaceId>"
}

Obter fluxo de dados com definição

Retorna a definição de item de fluxo de dados.

Pedido de amostra

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/getDefinition](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d/getDefinition)

Headers:

{
    "Authorization": "\<bearer-token>"
}

Exemplo de resposta

{ 

    "definition": { 

        "parts": [ 

            { 

                "path": "dataflow-content.json", 

                "payload": " ewogICAgImVkaXRpbmdTZXNzaW9uTWFzaHVwIjogewogICAgICAgICJtYXNodXBOYW1lIjogIiIsCiAgICAgICAgIm1hc2h1cERvY3VtZW50IjogInNlY3Rpb24gU2VjdGlvbjE7XHJcbnNoYXJlZCBRdWVyeSA9IGxldFxuIFNvdXJjZSA9IFRhYmxlLkZyb21Sb3dzKFxuIHtcbiB7MSwgXCJCb2JcIiwgXCIxMjMtNDU2N1wifSxcbiB7MiwgXCJKaW1cIiwgXCI5ODctNjU0M1wifVxuIH0sXG4ge1wiQ3VzdG9tZXJJRFwiLCBcIk5hbWVcIiwgXCJQaG9uZVwifSlcbmluXG4gU291cmNlO1xyXG4iLAogICAgICAgICJxdWVyeUdyb3VwcyI6IFtdLAogICAgICAgICJkb2N1bWVudExvY2FsZSI6ICJlbi1VUyIsCiAgICAgICAgImdhdGV3YXlPYmplY3RJZCI6IG51bGwsCiAgICAgICAgInF1ZXJpZXNNZXRhZGF0YSI6IG51bGwsCiAgICAgICAgImNvbm5lY3Rpb25PdmVycmlkZXMiOiBbXSwKICAgICAgICAidHJ1c3RlZENvbm5lY3Rpb25zIjogbnVsbCwKICAgICAgICAidXNlSG9zdENvbm5lY3Rpb25Qcm92aWRlciI6IGZhbHNlLAogICAgICAgICJmYXN0Q29tYmluZSI6IGZhbHNlLAogICAgICAgICJhbGxvd05hdGl2ZVF1ZXJpZXMiOiB0cnVlLAogICAgICAgICJhbGxvd2VkTW9kdWxlcyI6IG51bGwsCiAgICAgICAgInNraXBBdXRvbWF0aWNUeXBlQW5kSGVhZGVyRGV0ZWN0aW9uIjogZmFsc2UsCiAgICAgICAgImRpc2FibGVBdXRvQW5vbnltb3VzQ29ubmVjdGlvblVwc2VydCI6IG51bGwsCiAgICAgICAgImhvc3RQcm9wZXJ0aWVzIjogewogICAgICAgICAgICAiRGF0YWZsb3dSZWZyZXNoT3V0cHV0RmlsZUZvcm1hdCI6ICJQYXJxdWV0IiwKICAgICAgICAgICAgIkVuYWJsZURhdGVUaW1lRmllbGRzRm9yU3RhZ2luZyI6ICJ0cnVlIiwKICAgICAgICAgICAgIkVuYWJsZVB1Ymxpc2hXaXRob3V0TG9hZGVkUXVlcmllcyI6ICJ0cnVlIgogICAgICAgIH0sCiAgICAgICAgImRlZmF1bHRPdXRwdXREZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb24iOiBudWxsLAogICAgICAgICJzdGFnaW5nRGVmaW5pdGlvbiI6IG51bGwKICAgIH0KfQ==" 

                "payloadType": "InlineBase64" 

            }, 

            { 

                "path": ".platform", 

                "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJEYXRhZmxvdyAzIgogIH0sCiAgImNvbmZpZyI6IHsKICAgICJ2ZXJzaW9uIjogIjIuMCIsCiAgICAibG9naWNhbElkIjogIjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCIKICB9Cn0=", 

                "payloadType": "InlineBase64" 

            } 

        ] 

    } 

}

RESPOSTA DE API

{ 
    'definition':  
    { 
        'parts': [ 
            { 
                'path': 'queryMetadata.json', 'payload': '<super long entry>', 'payloadType': 'InlineBase64' 
            }, 
            { 
                'path': 'mashup.pq', 'payload': '<super long entry>', 'payloadType': 'InlineBase64' 
            }, 
            { 
                'path': '.platform', 'payload': '<super long entry>', 'payloadType': 'InlineBase64' 
            } 
        ] 
    } 
}

Atualizar fluxo de dados

Atualiza as propriedades do fluxo de dados.

Pedido de amostra

URI: PATCH [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d)  

Headers: 

{ 
  "Authorization": "\<bearer-token>", 
  "Content-Type": "application/json" 
} 

Payload: 
{ 
  "displayName": "My dataflow updated", 
  "description": "My dataflow description updated", 
  "type": "Dataflow" 
}

Exemplo de resposta

{ 
    "id": "\<artifactId>", 
    "type": "Dataflow", 
    "displayName": "My dataflow updated", 
    "description": "My dataflow description updated", 
    "workspaceId": "\<workspaceId>" 
}

Atualizar fluxo de dados com definição

Atualiza a definição do item de fluxo de dados.

Pedido de amostra

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/updateDefinition](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d/updateDefinition) 

Headers: 

{ 
  "Authorization": "\<bearer-token>", 
  "Content-Type": "application/json" 
} 

Payload: 

{ 
  "displayName": " My dataflow", 
  "type": "Dataflow", 
  "definition": { 
    "parts": [  
      {  
        "path": "dataflow-content.json",  
        "payload": " ewogICAgImVkaXRpbmdTZXNzaW9uTWFzaHVwIjogewogICAgICAgICJtYXNodXBOYW1lIjogIiIsCiAgICAgICAgIm1hc2h1cERvY3VtZW50IjogInNlY3Rpb24gU2VjdGlvbjE7XHJcbnNoYXJlZCBRdWVyeSA9IGxldFxuIFNvdXJjZSA9IFRhYmxlLkZyb21Sb3dzKFxuIHtcbiB7MSwgXCJCb2JcIiwgXCIxMjMtNDU2N1wifSxcbiB7MiwgXCJKaW1cIiwgXCI5ODctNjU0M1wifVxuIH0sXG4ge1wiQ3VzdG9tZXJJRFwiLCBcIk5hbWVcIiwgXCJQaG9uZVwifSlcbmluXG4gU291cmNlO1xyXG4iLAogICAgICAgICJxdWVyeUdyb3VwcyI6IFtdLAogICAgICAgICJkb2N1bWVudExvY2FsZSI6ICJlbi1VUyIsCiAgICAgICAgImdhdGV3YXlPYmplY3RJZCI6IG51bGwsCiAgICAgICAgInF1ZXJpZXNNZXRhZGF0YSI6IG51bGwsCiAgICAgICAgImNvbm5lY3Rpb25PdmVycmlkZXMiOiBbXSwKICAgICAgICAidHJ1c3RlZENvbm5lY3Rpb25zIjogbnVsbCwKICAgICAgICAidXNlSG9zdENvbm5lY3Rpb25Qcm92aWRlciI6IGZhbHNlLAogICAgICAgICJmYXN0Q29tYmluZSI6IGZhbHNlLAogICAgICAgICJhbGxvd05hdGl2ZVF1ZXJpZXMiOiB0cnVlLAogICAgICAgICJhbGxvd2VkTW9kdWxlcyI6IG51bGwsCiAgICAgICAgInNraXBBdXRvbWF0aWNUeXBlQW5kSGVhZGVyRGV0ZWN0aW9uIjogZmFsc2UsCiAgICAgICAgImRpc2FibGVBdXRvQW5vbnltb3VzQ29ubmVjdGlvblVwc2VydCI6IG51bGwsCiAgICAgICAgImhvc3RQcm9wZXJ0aWVzIjogewogICAgICAgICAgICAiRGF0YWZsb3dSZWZyZXNoT3V0cHV0RmlsZUZvcm1hdCI6ICJQYXJxdWV0IiwKICAgICAgICAgICAgIkVuYWJsZURhdGVUaW1lRmllbGRzRm9yU3RhZ2luZyI6ICJ0cnVlIiwKICAgICAgICAgICAgIkVuYWJsZVB1Ymxpc2hXaXRob3V0TG9hZGVkUXVlcmllcyI6ICJ0cnVlIgogICAgICAgIH0sCiAgICAgICAgImRlZmF1bHRPdXRwdXREZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb24iOiBudWxsLAogICAgICAgICJzdGFnaW5nRGVmaW5pdGlvbiI6IG51bGwKICAgIH0KfQ==",  
        "payloadType": "InlineBase64"  
      } 
    ] 
  } 
}

Exemplo de resposta

200 OK

Excluir fluxo de dados

Exclui o fluxo de dados especificado.

Pedido de amostra

URI: DELETE [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d)  

Headers: 

{ 
  "Authorization": "\<bearer-token>" 
}

Exemplo de resposta

200 OK

Executar trabalho de fluxo de dados sob demanda (atualização)

Executa o trabalho de fluxo de dados sob demanda para a instância de atualização.

Pedido de amostra

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances?jobType=Refresh](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d/jobs/instances?jobType=Refresh)  

Headers: 

{ 
  "Authorization": "\<bearer-token>" 
} 

Payload: 

{ 
    "executionData": { 
        "DataflowName": "Dataflow", 
        "OwnerUserPrincipalName": "\<name@email.com>", 
        "OwnerUserObjectId": "\<ObjectId>" 
    } 
}

Exemplo de resposta

202 Accepted 
[ 
  { 
    "id": "\<jobId>", 
    "itemId": "\<dataflowItemId>", 
    "jobType": "Refresh", 
    "invokeType": "OnDemand", 
    "status": "Accepted", 
    "jobInstanceId": "\<uniqueJobInstanceId>", 
    "rootActivityId": "\<rootActivityId>", 
    "startTimeUtc": "2025-01-30T11:10:50Z", 
    "endTimeUtc": null, 
    "failureReason": null 
  } 
]

Executar trabalho de publicação de fluxo de dados a pedido

Executa um trabalho de fluxo de dados sob solicitação para a instância de publicação.

Pedido de amostra

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances?jobType=Publish](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d/jobs/instances?jobType=Publish) 

Headers: 

{ 
  "Authorization": "\<bearer-token>" 
} 

Payload: 

{ 
    "executionData": { 
        "DataflowName": "Dataflow", 
        "OwnerUserPrincipalName": "\<name@email.com>", 
        "OwnerUserObjectId": "\<ObjectId>" 
    }
}

Exemplo de resposta

202 Accepted 

[ 
  { 
    "id": "\<jobId>", 
    "itemId": "\<dataflowItemId>", 
    "jobType": "Publish", 
    "invokeType": "OnDemand", 
    "status": "Accepted", 
    "jobInstanceId": "\<uniqueJobInstanceId>", 
    "rootActivityId": "\<rootActivityId>", 
    "startTimeUtc": "2025-01-30T11:10:50Z", 
    "endTimeUtc": null, 
    "failureReason": null 
  } 
]

Obter instância de trabalho de Dataflow

Obtém a instância de trabalho do fluxo de dados singular.

Pedido de amostra

URI: GET [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances/{jobInstanceId}](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d/jobs/instances/%7bjobInstanceId%7d)  

Headers: 

{ 
  "Authorization": "\<bearer-token>" 
}

Exemplo de resposta

{ 
  "id": "\<id>", 
  "itemId": "<itemId?", 
  "jobType": "Refresh", 
  "invokeType": "Manual", 
  "status": "Completed", 
  "rootActivityId": "\<rootActivityId>", 
  "startTimeUtc": "2023-08-22T06:35:00.7812154", 
  "endTimeUtc": "2023-08-22T06:35:00.8033333", 
  "failureReason": null 
}

Cancelar instância de trabalho de fluxo de dados

Cancelar a instância de trabalho de um fluxo de dados

Pedido de amostra

URI: POST [https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances/{jobInstanceId}/cancel](https://api.fabric.microsoft.com/v1/workspaces/%7bworkspaceId%7d/items/%7bitemId%7d/jobs/instances/%7bjobInstanceId%7d/cancel)  

Headers: 

{ 
  "Authorization": "\<bearer-token>"
}

Exemplo de resposta

Location: https://api.fabric.microsoft.com/v1/workspaces/\<worksapceId>/items/\<itemId>/jobs/instances/\<jobInstanceId> 

Retry-After: 60

Limitações atuais

Atualmente, não há suporte para a autenticação do Principal de Serviço.
"Obter Item" e "Listar Detalhes de Acesso ao Item" não retornará as informações corretas se você filtrar o tipo de item de fluxo de dados.
Quando não se especifica o tipo, retornará o Dataflow Gen2 (CI/CD, pré-visualização) - o novo Dataflow Gen2 com suporte a CI/CD e GIT.
As APIs de execução são invocáveis, mas a execução real nunca é bem-sucedida.

Partilhar via

Recursos de APIs públicas para Dataflows Gen2 no Fabric Data Factory (Visualização)

Casos de uso de APIs para fluxos de dados

Noções básicas sobre APIs

Suporte CRUD

Ciclo de vida do fluxo de dados

Introdução às APIs públicas para fluxos de dados

Obter um token de autorização

MSAL.Net

Portal de Tecido

Criar um fluxo de dados

Criar um fluxo de dados com definição

Obter fluxo de dados

Obter fluxo de dados com definição

Atualizar fluxo de dados

Atualizar fluxo de dados com definição

Excluir fluxo de dados

Executar trabalho de fluxo de dados sob demanda (atualização)

Executar trabalho de publicação de fluxo de dados a pedido

Obter instância de trabalho de Dataflow

Cancelar instância de trabalho de fluxo de dados

Limitações atuais

Conteúdo relacionado

Documentação

Tutoriais

Comentários

Recursos adicionais