Conjunto de datos versión 1 (V1)

Artículo
05/07/2024

Nota

Esta documentación de referencia se aplica a Azure Data Factory versión 1 (V1).

Crear o actualizar

Crea un nuevo conjunto de datos o actualiza el contenido de un conjunto de datos existente.

Solicitud

La solicitud Crear o actualizar conjunto de datos se puede construir de la siguiente manera (se recomienda HTTPS):

Verbo HTTP	URI de solicitud	Versión 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 identificador URI

Parámetro de URI	Obligatorio	Descripción
SubscriptionID	Sí	Su identificador de suscripción de Azure.
ResourceGroupName	Sí	El nombre único para el grupo de recursos que hospeda su servicio de Factoría de datos de Azure.
DataFactoryName	Sí	Nombre de la factoría de datos en la que desea crear el conjunto de datos.
DatasetName	Sí	Nombre del conjunto de datos que desea crear.
Api-Version	Sí	Especifica la versión del protocolo utilizado para realizar esta solicitud.

Encabezados de solicitud

La tabla siguiente describe los encabezados de solicitud.

Encabezado de la solicitud	Obligatorio	Descripción
x-ms-client-request-id	Sí	El identificador de operación de esta solicitud.

Cuerpo de la solicitud

El cuerpo de la solicitud depende del tipo de conjunto de datos. En el ejemplo siguiente se usa el conjunto de datos AzureBlob.

El formato del cuerpo de la solicitud es el siguiente.

{  
  "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 datos en Azure Data Factory artículo para obtener descripciones de las propiedades en json.

Response

La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo de respuesta.

Código de estado

200 (Correcto), si la solicitud se completó correctamente.
202 (Aceptado), si se aceptó la solicitud.
400 (Solicitud incorrecta), si el cuerpo de la solicitud no se puede validar.
404 (No encontrado), si la suscripción o el grupo de recursos no existe.
412 (Error de condición previa), si la condición especificada por el encabezado If-Match produjo un error.
501 (No implementado), si la validación no está implementada.

Encabezados de respuesta

La respuesta para esta operación incluye los encabezados siguientes. La respuesta también puede incluir otros encabezados HTTP estándar. Todos los encabezados estándar se ajustan a la especificación del protocolo HTTP/1.1.

Encabezado de respuesta	Descripción
x-ms-request-id	Identificador único de la operación o servicio actual generado.
x-ms-ratelimit-Remaining-Subscription-Writes	El límite restante para la suscripción actual.
x-ms-correlation-request-id	Especifica el identificador de la correlación de seguimiento para la solicitud; el proveedor de recursos debe registrar esto para que las solicitudes de un extremo a otro se puedan correlacionar a través de Azure.
x-ms-routing-request-id	Location+DateTime+correlation-request-ID
Fecha	Valor de fecha y hora UTC generado por el servicio que indica la hora a la que se inició la respuesta.
Location	URI del objeto que desea crear u obtener.

Cuerpo de la respuesta

{  
  "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 datos en Azure Data Factory artículo para obtener descripciones de las propiedades en json.

Solicitud y respuesta de ejemplo

URI de ejemplo:

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

La solicitud se envía con los encabezados siguientes:

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

y con el siguiente cuerpo:

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

Una vez enviada la solicitud, se devuelve la respuesta siguiente.

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

Eliminar

Elimina el conjunto de datos especificado.

Solicitud

La solicitud Eliminar conjunto de datos se puede construir de la siguiente manera (se recomienda HTTPS):

Verbo HTTP	URI de solicitud	Versión 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 identificador URI

Parámetro de URI	Obligatorio	Descripción
SubscriptionID	Sí	Su identificador de suscripción de Azure.
ResourceGroupName	Sí	El nombre único para el grupo de recursos que hospeda su servicio de Factoría de datos de Azure.
DataFactoryName	Sí	Nombre de la factoría de datos en la que desea eliminar el conjunto de datos.
DatasetName	Sí	Nombre del conjunto de datos que desea eliminar
Api-Version	Sí	Especifica la versión del protocolo utilizado para realizar esta solicitud.

Encabezados de solicitud

La tabla siguiente describe los encabezados de solicitud.

Encabezado de la solicitud	Obligatorio	Descripción
x-ms-client-request-id	Sí	El identificador de operación de esta solicitud.

Cuerpo de la solicitud

Ninguno.

Response

La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo de respuesta.

Código de estado

200 (Correcto), si la solicitud se completó correctamente.
400 (Solicitud incorrecta), si el cuerpo de la solicitud no se puede validar.
404 (No encontrado), si la suscripción o el grupo de recursos no existe.
412 (Error de condición previa), si la condición especificada por el encabezado If-Match produjo un error.
501 (No implementado), si la validación no está implementada.

Encabezados de respuesta

Encabezado de respuesta	Descripción
x-ms-request-id	Identificador único de la operación o servicio actual generado.
x-ms-ratelimit-Remaining-Subscription-Writes	El límite restante para la suscripción actual.
x-ms-correlation-request-id	Especifica el identificador de la correlación de seguimiento para la solicitud; el proveedor de recursos debe registrar esto para que las solicitudes de un extremo a otro se puedan correlacionar a través de Azure.
x-ms-routing-request-id	Location+DateTime+correlation-request-ID
Fecha	Valor de fecha y hora UTC generado por el servicio que indica la hora a la que se inició la respuesta.

Cuerpo de la respuesta

Ninguno.

Solicitud y respuesta de ejemplo

URI de ejemplo:

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

La solicitud se envía con los encabezados siguientes.

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

Una vez enviada la solicitud, se devuelve la respuesta siguiente.

  
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

Obtiene información sobre los conjuntos de datos de una factoría de datos.

Solicitud

La solicitud Obtener conjunto de datos se puede construir de la siguiente manera (se recomienda HTTPS):

Verbo HTTP	URI de solicitud	Versión 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 identificador URI

Parámetro de URI	Obligatorio	Descripción
SubscriptionID	Sí	Su identificador de suscripción de Azure.
ResourceGroupName	Sí	Nombre único para el grupo de recursos que hospeda su servicio de Factoría de datos de Azure.
DataFactoryName	Sí	Nombre de la factoría de datos en la que desea obtener el conjunto de datos.
DatasetName	Sí	Nombre del conjunto de datos que desea obtener.
Api-Version	Sí	Especifica la versión del protocolo utilizado para realizar esta solicitud.

Encabezados de solicitud

La tabla siguiente describe los encabezados de solicitud.

Encabezado de la solicitud	Requerido	Descripción
x-ms-client-request-id	Sí	El identificador de operación de esta solicitud.

Cuerpo de la solicitud

Ninguno.

Response

La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo de respuesta.

Código de estado

200 (Correcto), si la solicitud se completó correctamente.
400 (Solicitud incorrecta), si el cuerpo de la solicitud no se puede validar.
404 (No encontrado), si la suscripción o el grupo de recursos no existe.
412 (Error de condición previa), si la condición especificada por el encabezado If-Match produjo un error.

Encabezados de respuesta

Encabezado de respuesta	Descripción
x-ms-request-id	Identificador único de la operación o servicio actual generado.
x-ms-ratelimit-Remaining-Subscription-Writes	El límite restante para la suscripción actual.
x-ms-correlation-request-id	Especifica el identificador de la correlación de seguimiento para la solicitud. El proveedor de recursos debe registrar esto para que las solicitudes de un extremo a otro se puedan correlacionar entre Azure.
x-ms-routing-request-id	Location+DateTime+correlation-request-ID
Fecha	Valor de fecha y hora UTC generado por el servicio que indica la hora a la que se inició la respuesta.

Cuerpo de la respuesta

El cuerpo de la respuesta depende del tipo de conjunto de datos. En este ejemplo se usa un conjunto de datos de 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 el artículo Conjuntos de datos en Azure Data Factory para obtener descripciones de las propiedades en json.

Solicitud y respuesta de ejemplo

URI de ejemplo:

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

La solicitud se envía con los encabezados siguientes.

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

Una vez enviada la solicitud, se devuelve la respuesta siguiente.

Encabezado:

  
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

La respuesta incluye el siguiente cuerpo XML.

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

List

Listas información de todos los conjuntos de datos de la factoría de datos.

Solicitud

La solicitud List Datasets se puede construir de la siguiente manera (se recomienda HTTPS):

Verbo HTTP	URI de solicitud	Versión 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 identificador URI

Parámetro de URI	Obligatorio	Descripción
SubscriptionID	Sí	Su identificador de suscripción de Azure.
ResourceGroupName	Sí	Un nombre único para el grupo de recursos que hospeda su servicio de Factoría de datos de Azure.
DataFactoryName	Sí	Nombre de la factoría de datos que desea encontrar el conjunto de datos.
Api-Version	Sí	Especifica la versión del protocolo utilizado para realizar esta solicitud.

Encabezados de solicitud

La tabla siguiente describe los encabezados de solicitud.

Encabezado de la solicitud	Obligatorio	Descripción
x-ms-client-request-id	Sí	El identificador de operación de esta solicitud.

Cuerpo de la solicitud

Ninguno.

Response

La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo de respuesta.

Código de estado

200 (Correcto), si la solicitud se completó correctamente.
400 (Solicitud incorrecta), si el cuerpo de la solicitud no se puede validar.
404 (No encontrado), si la suscripción o el grupo de recursos no existe.
412 (Error de condición previa), si la condición especificada por el encabezado If-Match produjo un error.

Encabezados de respuesta

Encabezado de respuesta	Descripción
x-ms-request-id	Identificador único de la operación o servicio actual generado.
x-ms-ratelimit-Remaining-Subscription-Writes	El límite restante para la suscripción actual.
x-ms-correlation-request-id	Especifica el identificador de la correlación de seguimiento para la solicitud. El proveedor de recursos debe registrar esto para que las solicitudes de un extremo a otros se puedan correlacionar a través de Azure.
x-ms-routing-request-id	Location+DateTime+correlation-request-ID
Fecha	Valor de fecha y hora UTC generado por el servicio que indica la hora a la que se inició la respuesta.

Cuerpo de la respuesta

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

Si hay más de 100 registros, obtendrá 100 registros a la vez con un 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"
}

Envíe la siguiente solicitud mediante la dirección URL nextLink para obtener el siguiente conjunto de registros. Es posible que tenga que encapsular & con comillas dobles ("") en la dirección URL de nextLink. Solo se devuelven 100 registros a la vez.

Consulte el artículo Conjuntos de datos en Azure Data Factory para obtener descripciones de las propiedades en json.

Solicitud y respuesta de ejemplo

URI de ejemplo:

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

La solicitud se envía con los encabezados siguientes.

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

Una vez enviada la solicitud, se devuelve la respuesta siguiente.

  
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

La respuesta incluye el siguiente cuerpo XML.

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

Ventanas de actividad de lista

Listas la primera página de instancias de ventana de actividad asociadas a un conjunto de datos junto con un vínculo a la página siguiente.

Solicitud

La solicitud de ventana Obtener actividad se puede construir de la siguiente manera (se recomienda HTTPS):

Verbo HTTP	URI de solicitud	Versión 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 identificador URI

Parámetro del URI	Requerido	Descripción
SubscriptionID	Sí	Su identificador de suscripción de Azure.
ResourceGroupName	Sí	Nombre del grupo de recursos que hospeda la factoría de datos de Azure.
DataFactoryName	Sí	El nombre de la factoría de datos.
DatasetName	Sí	Nombre del conjunto de datos.
Api-Version	Sí	Especifica la versión del protocolo utilizado para realizar esta solicitud.

Encabezados de solicitud

La tabla siguiente describe los encabezados de solicitud.

Encabezado de la solicitud	Requerido	Descripción
x-ms-client-request-id	Sí	El identificador de operación de esta solicitud.

Cuerpo de la solicitud

Nombre del elemento	Descripción	Requerido
Filtrar	Filtro de ventana de actividad especificado mediante la gramática de filtro de Azure Search. Para obtener información detallada, vea https://msdn.microsoft.com/library/azure/dn798921.aspx.	No
OrderBy	Ordene la respuesta por las propiedades de la ventana de actividad especificadas. Se trata de una lista de propiedades separadas por comas. Por ejemplo: WindowStart, PercentComplete. Por befault, el orden es ascendente (ASC). Especifique DESC si desea que la lista se ordene en orden descendente.	No
Superior	Número de ventanas de actividad que se mostrarán.	No
RunStart	Hora de inicio de la ejecución de la ventana de actividad.	No
RunEnd	Hora de finalización de la ejecución de la ventana de actividad.	No
WindowStart	Ventana de actividad de hora de inicio.	No
WindowEnd	Hora de finalización de la ventana de actividad.	No
WindowState	Estado de la ventana de actividad. Debe ser uno de los valores especificados en este artículo.	No
WindowSubstate	Subestado de la ventana de actividad. Debe ser uno de los valores especificados en este artículo.	No

Response

La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo de respuesta.

Código de estado

200 (Correcto), si la solicitud se completó correctamente.
400 (Solicitud incorrecta), si el cuerpo de la solicitud no se puede validar.
404 (No encontrado), si la suscripción o el grupo de recursos no existe.

Encabezados de respuesta

Encabezado de respuesta	Descripción
x-ms-request-id	Identificador único de la operación o servicio actual generado.
x-ms-ratelimit-Remaining-Subscription-Writes	El límite restante para la suscripción actual.
x-ms-correlation-request-id	Especifica el identificador de la correlación de seguimiento para la solicitud. El proveedor de recursos debe registrar esto para que las solicitudes de un extremo a otros se puedan correlacionar a través de Azure.
x-ms-routing-request-id	Location+DateTime+correlation-request-ID
Fecha	Valor de fecha y hora UTC generado por el servicio que indica la hora a la que se inició la respuesta.

Cuerpo de la respuesta

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

Solicitud y respuesta de ejemplo

URI de ejemplo:

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

La solicitud se envía con los siguientes encabezados y el cuerpo:

Encabezado:

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

Cuerpo:

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

Una vez enviada la solicitud, se devuelve la respuesta siguiente.

  
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

La respuesta incluye el siguiente cuerpo XML.

{
  "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 la dirección URL nextLink para obtener la siguiente página de resultados.

Compartir a través de

Conjunto de datos versión 1 (V1)

Crear o actualizar

Solicitud

Parámetros de identificador URI

Encabezados de solicitud

Cuerpo de la solicitud

Response

Código de estado

Encabezados de respuesta

Cuerpo de la respuesta

Solicitud y respuesta de ejemplo

Eliminar

Solicitud

Parámetros de identificador URI

Encabezados de solicitud

Cuerpo de la solicitud

Response

Código de estado

Encabezados de respuesta

Cuerpo de la respuesta

Solicitud y respuesta de ejemplo

Get

Solicitud

Parámetros de identificador URI

Encabezados de solicitud

Cuerpo de la solicitud

Response

Código de estado

Encabezados de respuesta

Cuerpo de la respuesta

Solicitud y respuesta de ejemplo

List

Solicitud

Parámetros de identificador URI

Encabezados de solicitud

Cuerpo de la solicitud

Response

Código de estado

Encabezados de respuesta

Cuerpo de la respuesta

Solicitud y respuesta de ejemplo

Ventanas de actividad de lista

Solicitud

Parámetros de identificador URI

Encabezados de solicitud

Cuerpo de la solicitud

Response

Código de estado

Encabezados de respuesta

Cuerpo de la respuesta

Solicitud y respuesta de ejemplo

Recursos adicionales