Compartilhar via

Conjunto de dados versão 1 (V1)

  • Artigo

Observação

Esta documentação de referência se aplica a Azure Data Factory versão 1 (V1).

Criar ou atualizar

Cria um novo conjunto de dados ou atualiza o conteúdo de um conjunto de dados existente.

Solicitação

A solicitação Criar ou Atualizar Conjunto de Dados pode ser construída da seguinte maneira (HTTPS é recomendado):

Verbo HTTP URI da solicitação Versão HTTP
PUT https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/datasets/{DatasetName}?api-version={api-version} HTTP/1.1

Parâmetros de URI

Parâmetro URI Necessário Descrição
SubscriptionID Yes Sua ID da assinatura do Azure.
ResourceGroupName Yes O nome exclusivo para o grupo de recursos que hospeda sua Fábrica de Dados do Azure.
DataFactoryName Yes Nome do data factory no qual você deseja criar seu conjunto de dados.
DatasetName Yes Nome do conjunto de dados que você deseja criar.
Versão da API Yes Especifica a versão do protocolo usado para fazer essa solicitação.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos da solicitação.

Cabeçalho da solicitação Necessário Descrição
x-ms-client-request-id Yes A ID da operação para essa solicitação.

Corpo da solicitação

O corpo da solicitação depende do tipo de conjunto de dados. O exemplo aqui usa o conjunto de dados AzureBlob.

O formato do corpo da solicitação é o seguinte.

{  
  "name": "MyDataset",  
  "properties": {  
    "structure": [  
      {  
        "name": "Column1",  
        "type": "String"  
      },  
      {  
        "name": "Column2",  
        "type": "String"  
      }  
    ],  
    "type": "<Dataset type>",  
    "linkedServiceName": "<Name of the linked service that contains the data>",  
    "typeProperties": {  
            "type specific property": "<value>",  
            "type specific property 2": "<value>"  
    },  
    "external": true,  
    "availability": {  
      "frequency": "<Hour/Day/etc...>",  
      "interval": <number>  
    }  
  }  
}

Consulte Conjuntos de dados em Azure Data Factory artigo para obter descrições de propriedades no JSON.

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Código de status

  • 200 (OK) – quando a solicitação é concluída com êxito.

  • 202 (Aceito) – quando a solicitação é aceita.

  • 400 (Solicitação Incorreta) – quando o corpo da solicitação falha na validação.

  • 404 (Não Encontrado) – quando a assinatura ou grupo de recursos não existe.

  • 412 (Falha na Pré-condição) – quando a condição especificada pelo cabeçalho If-Match falha.

  • 501 (Não Implementado) – quando a validação não está implementada

Cabeçalhos de resposta

A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de resposta Descrição
x-ms-request-id Um identificador exclusivo para a operação atual, serviço gerado.
x-ms-ratelimit-remaining-subscription-writes O limite restante da assinatura atual.
x-ms-correlation-request-id Especifica a ID de correlação de rastreamento para a solicitação; o provedor de recursos deve registrar isso para que as solicitações de ponta a ponta possam ser correlacionadas no Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Data Um valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada.
Localização URI do objeto que você deseja criar ou obter.

Corpo da resposta

{  
  "name": "InputDataset",  
  "id":  
"/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/  
<data factory name>/tables/InputDataset",  
    "type": "AzureBlob",  
    "linkedServiceName": "<Name of the Data Factory linked service that contains the data>",  
    "typeProperties": {  
            "type specific property": "<value>",  
            "type specific property 2": "<value>"  
    },  
    "availability": {  
      "frequency": "<Hour | Day etc...>",  
      "interval": <number>  
    },  
    "external": true,  
    "policy": {},  
    "id": "7c4495bf-f12b-46b6-a653-d4cda899c91c",  
    "createTime": "2016-02-06T00:41:05.2978434Z",  
    "provisioningState": "Succeeded"  
  }  
}

Consulte Conjuntos de dados em Azure Data Factory artigo para obter descrições de propriedades no JSON.

Exemplo de solicitação e resposta

URI de exemplo:

PUT: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/adf/providers/Microsoft.DataFactory/datafactories/test/datasets/datasettest?api-version=2015-10-01

A solicitação é enviada com os seguintes cabeçalhos:

x-ms-client-request-id        : 00000000-1111-1111-1111-000000000000

e com o seguinte corpo:

{  
  "name": "InputDataset",  
  "properties": {  
    "structure": [  
      {  
        "name": "FirstName",  
        "type": "String"  
      },  
      {  
        "name": "LastName",  
        "type": "String"  
      }  
    ],  
    "type": "AzureBlob",  
    "linkedServiceName": "StorageLinkedService",  
    "typeProperties": {  
      "folderPath": "adftutorial/",  
      "fileName": "emp.txt",  
      "format": {  
        "type": "TextFormat",  
        "columnDelimiter": ","  
      }  
    },  
    "external": true,  
    "availability": {  
      "frequency": "Hour",  
      "interval": 1  
    }  
  }  
}

Depois que a solicitação tiver sido enviada, a resposta a seguir será retornada.

  
Status Code:  
OK  
  
Headers:  
Pragma                        : no-cache  
x-ms-request-id               : 00000000-0000-0000-0000-000000000000  
x-ms-ratelimit-remaining-subscription-reads: 14979  
x-ms-correlation-request-id   : 00000000-0000-0000-0000-000000000000  
x-ms-routing-request-id       : EASTUS:20160206T004111Z:00000000-0000-0000-0000-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Sat, 06 Feb 2016 00:41:10 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET  
  
Body:  
{  
  "name": "InputDataset",  
  "id":  
"/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/  
<name of data factory>/tables/InputDataset",  
  "properties": {  
    "structure": [  
      {  
        "name": "FirstName",  
        "type": "String"  
      },  
      {  
        "name": "LastName",  
        "type": "String"  
      }  
    ],  
    "published": false,  
    "type": "AzureBlob",  
    "linkedServiceName": "StorageLinkedService",  
    "typeProperties": {  
      "fileName": "emp.txt",  
      "folderPath": "adftutorial/",  
      "format": {  
        "type": "TextFormat",  
        "columnDelimiter": ","  
      }  
    },  
    "availability": {  
      "frequency": "Hour",  
      "interval": 1  
    },  
    "external": true,  
    "policy": {},  
    "id": "00000000-0000-0000-0000-000000000000",  
    "createTime": "2016-02-06T00:41:05.2978434Z",  
    "provisioningState": "Succeeded"  
  }  
}

Excluir

Exclui o conjunto de dados especificado.

Solicitação

A solicitação Excluir Conjunto de Dados pode ser construída da seguinte maneira (HTTPS é recomendado):

Verbo HTTP URI da solicitação Versão HTTP
DELETE https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/dataset/{DatasetName}?api-version={api-version} HTTP/1.1

Parâmetros de URI

Parâmetro URI Necessário Descrição
SubscriptionID Yes Sua ID da assinatura do Azure.
ResourceGroupName Yes O nome exclusivo para o grupo de recursos que hospeda sua Fábrica de Dados do Azure.
DataFactoryName Yes Nome do data factory no qual você deseja excluir o conjunto de dados.
DatasetName Yes Nome do conjunto de dados que você deseja excluir
Versão da API Yes Especifica a versão do protocolo usado para fazer essa solicitação.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos da solicitação.

Cabeçalho da solicitação Necessário Descrição
x-ms-client-request-id Yes A ID da operação para essa solicitação.

Corpo da solicitação

Nenhum.

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Código de status

  • 200 (OK) – quando a solicitação é concluída com êxito.

  • 400 (Solicitação Incorreta) – quando o corpo da solicitação falha na validação.

  • 404 (Não Encontrado) – quando a assinatura ou grupo de recursos não existe.

  • 412 (Falha na Pré-condição) – quando a condição especificada pelo cabeçalho If-Match falha.

  • 501 (Não Implementado) – quando a validação não está implementada

Cabeçalhos de resposta

A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de resposta Descrição
x-ms-request-id Um identificador exclusivo para a operação atual, serviço gerado.
x-ms-ratelimit-remaining-subscription-writes O limite restante da assinatura atual.
x-ms-correlation-request-id Especifica a ID de correlação de rastreamento para a solicitação; o provedor de recursos deve registrar isso para que as solicitações de ponta a ponta possam ser correlacionadas no Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Data Um valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada.

Corpo da resposta

Nenhum.

Exemplo de solicitação e resposta

URI de exemplo:

DELETE: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/adf/providers/Microsoft.DataFactory/datafactories/test/dataset/myds?api-version=2015-10-01

A solicitação é enviada com os seguintes cabeçalhos.

x-ms-client-request-id        : 00000000-1111-1111-1111-000000000000

Depois que a solicitação tiver sido enviada, a resposta a seguir será retornada.

  
Status Code:  
OK  
  
Headers:  
Pragma                        : no-cache  
x-ms-request-id               : 00000000-1111-1111-1111-000000000000  
x-ms-ratelimit-remaining-subscription-writes: 799985  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : WESTUS:20141203T213307Z: 00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Wed, 03 Dec 2014 21:33:07 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET  
client-tracking-id            : 83

Get

Obtém informações sobre conjuntos de dados em um data factory.

Solicitação

A solicitação Obter Conjunto de Dados pode ser construída da seguinte maneira (HTTPS é recomendado):

Verbo HTTP URI da solicitação Versão HTTP
GET https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/datasets/{DatasetName}?api-version={api-version} HTTP/1.1

Parâmetros de URI

Parâmetro URI Necessário Descrição
SubscriptionID Yes Sua ID da assinatura do Azure.
ResourceGroupName Yes Um nome exclusivo para o grupo de recursos que hospeda seu serviço de fábrica de dados do Azure.
DataFactoryName Yes Nome do data factory no qual você deseja obter seu conjunto de dados.
DatasetName Yes Nome do conjunto de dados que você deseja obter.
Versão da API Yes Especifica a versão do protocolo usado para fazer essa solicitação.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos da solicitação.

Cabeçalho da solicitação Obrigatório Descrição
x-ms-client-request-id Yes A ID da operação para essa solicitação.

Corpo da solicitação

Nenhum.

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Código de status

  • 200 (OK) – quando a solicitação é concluída com êxito.

  • 400 (Solicitação Incorreta) – quando o corpo da solicitação falha na validação.

  • 404 (Não Encontrado) – quando a assinatura ou grupo de recursos não existe.

  • 412 (Falha na Pré-condição) – quando a condição especificada pelo cabeçalho If-Match falha.

Cabeçalhos de resposta

A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de resposta Descrição
x-ms-request-id Um identificador exclusivo para a operação atual, serviço gerado.
x-ms-ratelimit-remaining-subscription-writes O limite restante da assinatura atual.
x-ms-correlation-request-id Especifica a ID de correlação de rastreamento para a solicitação. O provedor de recursos deve registrar isso para que as solicitações de ponta a ponta possam ser correlacionadas no Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Data Um valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada.

Corpo da resposta

O corpo da resposta depende do tipo de conjunto de dados. Este exemplo usa um conjunto de dados AzureBlob.

{  
  "name": "InputDataset",  
  "id":  
"/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/  
<data factory name>/tables/InputDataset",  
    "type": "AzureBlob",  
    "linkedServiceName": "<Name of the Data Factory linked service that contains the data>",  
    "typeProperties": {  
            "type specific property": "<value>",  
            "type specific property 2": "<value>"  
    },  
    "availability": {  
      "frequency": "<Hour | Day etc...>",  
      "interval": <number>  
    },  
    "external": true,  
    "policy": {},  
    "id": "7c4495bf-f12b-46b6-a653-d4cda899c91c",  
    "createTime": "2016-02-06T00:41:05.2978434Z",  
    "provisioningState": "Succeeded"  
  }  
}

Consulte Conjuntos de dados em Azure Data Factory artigo para obter descrições de propriedades no JSON.

Exemplo de solicitação e resposta

URI de exemplo:

GET: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/adf/providers/Microsoft.DataFactory/datafactories/test/dataset/InputDataset?api-version=2015-10-01

A solicitação é enviada com os seguintes cabeçalhos.

x-ms-client-request-id        : 00000000-1111-1111-1111-000000000000

Depois que a solicitação tiver sido enviada, a resposta a seguir será retornada.

Cabeçalho:

  
Status Code:  
OK  
  
Headers:  
Pragma                        : no-cache  
x-ms-request-id               : 00000000-1111-1111-1111-000000000000  
x-ms-ratelimit-remaining-subscription-reads: 14998  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : EASTUS:20160206T004938Z:00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Sat, 06 Feb 2016 00:49:37 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET

A resposta inclui o corpo XML a seguir.

{  
  "name": "InputDataset",  
  "id":  
"/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/{data factory name>/tables/InputDataset",  
  "properties": {  
    "structure": [  
      {  
        "name": "FirstName",  
        "type": "String"  
      },  
      {  
        "name": "LastName",  
        "type": "String"  
      }  
    ],  
    "published": false,  
    "type": "AzureBlob",  
    "linkedServiceName": "StorageLinkedService",  
    "typeProperties": {  
      "fileName": "emp.txt",  
      "folderPath": "adftutorial/",  
      "format": {  
        "type": "TextFormat",  
        "columnDelimiter": ","  
      }  
    },  
    "availability": {  
      "frequency": "Hour",  
      "interval": 1  
    },  
    "external": true,  
    "policy": {},  
    "id": "00000000-1111-1111-1111-000000000000",  
    "createTime": "2016-02-06T00:41:05.2978434Z",  
    "provisioningState": "Succeeded"  
  }  
}

Lista

Listas informações de todos os conjuntos de dados no data factory.

Solicitação

A solicitação Listar Conjuntos de Dados pode ser construída da seguinte maneira (HTTPS é recomendado):

Verbo HTTP URI da solicitação Versão HTTP
GET https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/datasets?api-version={api-version} HTTP/1.1

Parâmetros de URI

Parâmetro URI Necessário Descrição
SubscriptionID Yes Sua ID da assinatura do Azure.
ResourceGroupName Yes Um nome exclusivo para o grupo de recursos que hospeda sua fábrica de dados do Azure.
DataFactoryName Yes Nome do data factory que você deseja localizar seu conjunto de dados.
Versão da API Yes Especifica a versão do protocolo usado para fazer essa solicitação.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos da solicitação.

Cabeçalho da solicitação Necessário Descrição
x-ms-client-request-id Yes A ID da operação para essa solicitação.

Corpo da solicitação

Nenhum.

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Código de status

  • 200 (OK) - se a solicitação foi concluída com êxito.

  • 400 (Solicitação Incorreta) – quando o corpo da solicitação falha na validação.

  • 404 (Não Encontrado) – quando a assinatura ou grupo de recursos não existe.

  • 412 (Falha na Pré-condição) – quando a condição especificada pelo cabeçalho If-Match falha.

Cabeçalhos de resposta

A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de resposta Descrição
x-ms-request-id Um identificador exclusivo para a operação atual, serviço gerado.
x-ms-ratelimit-remaining-subscription-writes O limite restante da assinatura atual.
x-ms-correlation-request-id Especifica a ID de correlação de rastreamento para a solicitação. O provedor de recursos deve registrar isso para que as solicitações de ponta a ponta possam ser correlacionadas no Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Data Um valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada.

Corpo da resposta

{  
  "value": [  
    {  
      "name": "Name of the dataset",  
      "id":  
"/subscriptions/{Subscription ID>/resourcegroups/{Resource Group Name>/providers/Microsoft.DataFactory/datafactories/  
<Data Factory Name>/tables/{datasetname>",  
      "properties": {  
        "published": false,  
        "type": "Type of the dataset",  
        "typeProperties": {},  
        "id": "00000000-0000-0000-0000-000000000000",  
        "createTime": "2016-02-22T20:19:27.250261Z",  
        "provisioningState": "Succeeded"  
      }  
    },  
    {  
      "name": "Name of the dataset",  
      "id":  
"/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/  
<data factory name>/tables/{datasetname>",  
      "properties": {  
        "published": false,  
        "type": "Type of the dataset",  
        "typeProperties": {},  
        "id": "11111111-111-1111-1111-1111111111111",  
        "createTime": "2016-02-22T21:43:50.3713029Z",  
        "provisioningState": "Succeeded"  
      }  
    }  
  ]  
}

Se houver mais de 100 registros, você obterá 100 registros por vez com um nextLink:

{
  "value": [
    {
      "name": "AzureBlobInput99",
      "id": "/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/ADFCopyTutorialDF/datasets/AzureBlobInput99",
      "properties": {
        "published": false,
        "type": "AzureBlob",
        "linkedServiceName": "AzureStorageLinkedService",
        "typeProperties": {},
        "id": "11111111-111-1111-1111-1111111111111",
        "createTime": "2016-08-27T01:59:21.5963602Z",
        "provisioningState": "Succeeded"
	   }
    }, 
    {
      "name": "AzureBlobInput100",
      "id": "/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/ADFCopyTutorialDF/datasets/AzureBlobInput100",
      "properties": {
        "published": false,
        "type": "AzureBlob",
        "linkedServiceName": "AzureStorageLinkedService",
        "typeProperties": {},
        "id": "11111111-111-1111-1111-1111111111111",
        "createTime": "2016-08-17T18:38:04.695873Z",
        "provisioningState": "Succeeded"
      }
	 }
  ],
  "nextLink": "https://management.azure.com/subscriptions/{subscription ID>/resourcegroups/{Resource group name>/providers/Microsoft.DataFactory/datafactories/{data factory name>/datasets?api-version=2015-10-01&%24skipToken=MSExNiFSR0YwWVVGeWRHbG1ZV04wCjEhNTIhUkVGZlpUSXlaR1UyTXpndFpURTJNeTAwWXpZNUxUaGhNR0l0Wm1VMU1ETmpOakF4T0RObA%3d%3d"
}

Você envia a próxima solicitação usando a URL nextLink para obter o próximo conjunto de registros. Talvez seja necessário encapsular & com aspas duplas ("") na URL nextLink. Apenas 100 registros são retornados por vez.

Consulte Conjuntos de dados em Azure Data Factory artigo para obter descrições de propriedades no JSON.

Exemplo de solicitação e resposta

URI de exemplo:

GET: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/adf/providers/Microsoft.DataFactory/datafactories/test/datasets?api-version=2015-10-01

A solicitação é enviada com os seguintes cabeçalhos.

x-ms-client-request-id        : 00000000-1111-1111-1111-000000000000

Depois que a solicitação tiver sido enviada, a resposta a seguir será retornada.

  
Status Code:  
OK  
  
Headers:  
Pragma                        : no-cache  
x-ms-request-id               : 00000000-1111-1111-1111-000000000000  
x-ms-ratelimit-remaining-subscription-reads: 14999  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : EASTUS:20160206T191716Z:00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Sat, 06 Feb 2016 19:17:15 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET

A resposta inclui o corpo XML a seguir.

{  
  "value": [  
    {  
      "name": "EmpTableFromBlob",  
      "id":  
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ADF/providers/Microsoft.DataFactory/datafactories/  
SPRestDataFactory/tables/EmpTableFromBlob",  
      "properties": {  
        "published": false,  
        "type": "AzureBlob",  
        "typeProperties": {},  
        "id": "35555f2c-2cfe-48f4-86a8-bce7a3f1d1bd",  
        "createTime": "2016-02-22T20:19:27.250261Z",  
        "provisioningState": "Succeeded"  
      }  
    },  
    {  
      "name": "EmpSQLTable",  
      "id":  
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ADF/providers/Microsoft.DataFactory/datafactories/  
SPRestDataFactory/tables/EmpSQLTable",  
      "properties": {  
        "published": false,  
        "type": "AzureSqlTable",  
        "typeProperties": {},  
        "id": "376389aa-cef0-4418-8c80-4a8f2af3a84b",  
        "createTime": "2016-02-22T21:43:50.3713029Z",  
        "provisioningState": "Succeeded"  
      }  
    }  
  ]  
}

Listar Windows de Atividades

Listas a primeira página das instâncias da janela de atividade associadas a um conjunto de dados, juntamente com um link para a próxima página.

Solicitação

A solicitação da janela Obter Atividade pode ser construída da seguinte maneira (HTTPS é recomendado):

Verbo HTTP URI da solicitação Versão de HTTP
POST https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName/datasets/{DatasetName}/activitywindows?api-version={api-version} HTTP/1.1

Parâmetros de URI

Parâmetro do URI Obrigatório Descrição
SubscriptionID Yes Sua ID da assinatura do Azure.
ResourceGroupName Yes Nome do grupo de recursos que hospeda o Azure Data Factory.
DataFactoryName Yes Nome do Data Factory.
DatasetName Yes Nome do conjunto de dados.
Versão da API Yes Especifica a versão do protocolo usado para fazer essa solicitação.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos da solicitação.

Cabeçalho da solicitação Obrigatório Descrição
x-ms-client-request-id Yes A ID da operação para essa solicitação.

Corpo da solicitação

Nome do elemento Descrição Obrigatório
Filtrar O filtro da janela de atividade especificado usando a gramática de filtro do Azure Search. Para obter detalhes, consulte https://msdn.microsoft.com/library/azure/dn798921.aspx. No
OrderBy Ordenar a resposta por propriedades de janela de atividade especificadas. Esta é uma lista de propriedades separadas por vírgulas. Por exemplo: WindowStart, PercentComplete. Por padrão, a ordem é crescente (ASC). Especifique DESC se quiser que a lista seja ordenada em ordem decrescente. No
Parte superior O número de janelas de atividade a serem listadas. No
RunStart A hora de início da execução da janela de atividade. No
RunEnd A hora de término da execução da janela de atividade. No
WindowStart A janela de atividade de hora de início. No
WindowEnd A hora de término da janela de atividade. No
WindowState O estado da janela de atividade. Deve ser um dos valores especificados neste artigo. No
WindowSubstate O subestado da janela de atividade. Deve ser um dos valores especificados neste artigo. No

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Código de status

  • 200 (OK) - se a solicitação foi concluída com êxito.

  • 400 (Solicitação Incorreta) – quando o corpo da solicitação falha na validação.

  • 404 (Não Encontrado) – quando a assinatura ou grupo de recursos não existe.

Cabeçalhos de resposta

A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de Resposta Descrição
x-ms-request-id Um identificador exclusivo para a operação atual, serviço gerado.
x-ms-ratelimit-remaining-subscription-writes O limite restante da assinatura atual.
x-ms-correlation-request-id Especifica a ID de correlação de rastreamento para a solicitação. O provedor de recursos deve registrar isso para que as solicitações de ponta a ponta possam ser correlacionadas no Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Data Um valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada.

Corpo da resposta

{  
    "value": {  
    "activityWindows": [  
      {  
        "resourceGroupName": "<resource group name>",  
        "dataFactoryName": "<data factory name>",  
        "pipelineName": "<pipeline name>",  
        "activityName": "<Pipeline activity name.>",  
        "linkedServiceName": "<linked service name>",  
        "activityType": "<The activity type>",  
        "runAttempts": "<Number of activity run attempts.>",  
        "runStart": "<start time of the last run>",  
        "runEnd": "<end time of the last run>",  
        "duration": "<duration of the activity window>",  
        "percentComplete": "<percent completion of activity window>",  
        "windowStart": "<window start time>",  
        "windowEnd": "<window end time>",  
        "windowState": "<window state>",  
        "windowSubstate": "<window substate>",  
        "inputDatasets": "[<input dataset names>]",  
        "outputDatasets": [  
          "<output dataset names>"  
        ],  
        "inputDatasetIds":["<input dataset ids>"],  
        "outputDatasetIds": [  
          "<output dataset ids>" 
        ]  
      }  
    ],  
    "lastUpdate":"<The approximate time for the last activity windows>",  
    "aggregates": {}  
  },  
    "nextLink": "<Link to next page>"  
}

Exemplo de solicitação e resposta

URI de exemplo:

POST:https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ADF/providers/Microsoft.DataFactory/datafactories/dfName/datasets/dsName/activitywindows?api-version=2015-10-01

A solicitação é enviada com os seguintes cabeçalhos e o corpo:

Cabeçalho:

x-ms-client-request-id        : 00000000-1111-1111-1111-000000000000

Corpo:

{
  "top": 5,
  "windowState": "Failed",
  "filter": "RunAttempts ge 1"
}

Depois que a solicitação tiver sido enviada, a resposta a seguir será retornada.

  
Status Code:  
OK  
  
Headers:  
Pragma                        : no-cache  
x-ms-request-id               : 00000000-1111-1111-1111-000000000000  
x-ms-ratelimit-remaining-subscription-writes: 799985  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : WESTUS:20141203T213307Z: 00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Wed, 03 Dec 2014 21:33:07 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET

A resposta inclui o corpo XML a seguir.

{
  "value": {
    "activityWindows": [
      {
        "resourceGroupName": "rgName",  
        "dataFactoryName": "dfName",  
        "pipelineName": "DP_WikipediaSamplePipeline",
        "activityName": "BlobToSqlCopyActivity",
        "linkedServiceName": "HDILinkedService",
        "activityType": "Copy",
        "runAttempts": 2,
        "runStart": "2016-11-18T20:16:43.149Z",
        "runEnd": "2016-11-18T20:20:06.517Z",
        "duration": "00:03:23.3680000",
        "percentComplete": 50,
        "windowStart": "2016-11-18T19:00:00Z",
        "windowEnd": "2016-11-18T20:00:00Z",
        "windowState": "Failed",
        "windowSubstate": "",
        "inputDatasets": [
          "DA_CuratedWikiData"
        ],
        "outputDatasets": [
          "DA_WikiAggregatedData"
        ],
        "inputDatasetIds": [
          "b7707e71-2bf8-4596-94c7-90676d67bb3d"
        ],
        "outputDatasetIds": [
          "5aee09bb-ec37-4c3e-b8c3-a974741769b4"
        ]
      },
      {
        "resourceGroupName": "rgName",  
        "dataFactoryName": "dfName",  
        "pipelineName": "DP_WikipediaSamplePipeline",
        "activityName": "BlobToSqlCopyActivity",
        "linkedServiceName": "HDILinkedService",
        "activityType": "Copy",
        "runAttempts": 2,
        "runStart": "2016-11-18T20:43:59.716Z",
        "runEnd": "2016-11-18T20:47:27.827Z",
        "duration": "00:03:28.1110000",
        "percentComplete": 50,
        "windowStart": "2016-11-18T15:00:00Z",
        "windowEnd": "2016-11-18T16:00:00Z",
        "windowState": "Failed",
        "windowSubstate": "",
        "inputDatasets": [
          "DA_CuratedWikiData"
        ],
        "outputDatasets": [
          "DA_WikiAggregatedData"
        ],
        "inputDatasetIds": [
          "b7707e71-2bf8-4596-94c7-90676d67bb3d"
        ],
        "outputDatasetIds": [
          "5aee09bb-ec37-4c3e-b8c3-a974741769b4"
        ]
      },
      {
        "resourceGroupName": "rgName",  
        "dataFactoryName": "dfName",  
        "pipelineName": "DP_WikipediaSamplePipeline",
        "activityName": "BlobToSqlCopyActivity",
        "linkedServiceName": "HDILinkedService",
        "activityType": "Copy",
        "runAttempts": 2,
        "runStart": "2016-11-18T20:50:54.688Z",
        "runEnd": "2016-11-18T20:54:19.826Z",
        "duration": "00:03:25.1370000",
        "percentComplete": 50,
        "windowStart": "2016-11-18T14:00:00Z",
        "windowEnd": "2016-11-18T15:00:00Z",
        "windowState": "Failed",
        "windowSubstate": "",
        "inputDatasets": [
          "DA_CuratedWikiData"
        ],
        "outputDatasets": [
          "DA_WikiAggregatedData"
        ],
        "inputDatasetIds": [
          "b7707e71-2bf8-4596-94c7-90676d67bb3d"
        ],
        "outputDatasetIds": [
          "5aee09bb-ec37-4c3e-b8c3-a974741769b4"
        ]
      },
      {
        "resourceGroupName": "rgName",  
        "dataFactoryName": "dfName",  
        "pipelineName": "DP_WikipediaSamplePipeline",
        "activityName": "BlobToSqlCopyActivity",
        "linkedServiceName": "HDILinkedService",
        "activityType": "Copy",
        "runAttempts": 2,
        "runStart": "2016-11-18T20:57:45.579Z",
        "runEnd": "2016-11-18T21:01:09.939Z",
        "duration": "00:03:24.3590000",
        "percentComplete": 50,
        "windowStart": "2016-11-18T13:00:00Z",
        "windowEnd": "2016-11-18T14:00:00Z",
        "windowState": "Failed",
        "windowSubstate": "",
        "inputDatasets": [
          "DA_CuratedWikiData"
        ],
        "outputDatasets": [
          "DA_WikiAggregatedData"
        ],
        "inputDatasetIds": [
          "b7707e71-2bf8-4596-94c7-90676d67bb3d"
        ],
        "outputDatasetIds": [
          "5aee09bb-ec37-4c3e-b8c3-a974741769b4"
        ]
      },
      {
        "resourceGroupName": "rgName",  
        "dataFactoryName": "dfName",  
        "pipelineName": "DP_WikipediaSamplePipeline",
        "activityName": "BlobToSqlCopyActivity",
        "linkedServiceName": "HDILinkedService",
        "activityType": "Copy",
        "runAttempts": 2,
        "runStart": "2016-11-18T21:11:26.944Z",
        "runEnd": "2016-11-18T21:14:52.082Z",
        "duration": "00:03:25.1380000",
        "percentComplete": 50,
        "windowStart": "2016-11-18T20:00:00Z",
        "windowEnd": "2016-11-18T21:00:00Z",
        "windowState": "Failed",
        "windowSubstate": "",
        "inputDatasets": [
          "DA_CuratedWikiData"
        ],
        "outputDatasets": [
          "DA_WikiAggregatedData"
        ],
        "inputDatasetIds": [
          "b7707e71-2bf8-4596-94c7-90676d67bb3d"
        ],
        "outputDatasetIds": [
          "5aee09bb-ec37-4c3e-b8c3-a974741769b4"
        ]
      }
    ],
    "lastUpdate": "2016-11-18T13:29:28.4180094-08:00",
    "aggregates": {}
  },  
    "nextLink": "https://localhost:86/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName/datafactories/dfName/datasets/dsName/activitywindows/skip=FG154H?ApiVerion01012015"
}

Use a URL nextLink para obter a próxima página de resultados.