Hub versión 1 (V1)
Nota:
Esta documentación de referencia se aplica a Azure Data Factory versión 1 (V1).
Create or Update (Crear o actualizar)
Crea un nuevo centro o actualiza el contenido de un centro existente.
Request
La solicitud Crear o actualizar centro 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}/hubs/{HubName}?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 crear el centro. |
HubName | Sí | Nombre del centro 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 centro. El formato del cuerpo de la solicitud es el siguiente:
{
"name": <hubname>,
"properties": {
"defaultCompute": <computemethod>,
"type": <hubtype>
}
}
En la tabla siguiente se describen los elementos del cuerpo de la solicitud.
Nombre del elemento | Obligatorio | Descripción |
---|---|---|
name | Sí | Nombre del concentrador. |
properties | Sí | Propiedad del centro. |
Response
La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo de respuesta.
Códigos 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), la suscripción o el grupo de recursos o la factoría de datos no existe.
412 (Error de condición previa), la condición especificada por el encabezado If-Match produjo un error.
501 (No implementado), 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": <name>,
"properties":
{
"defaultCompute": <computemethod>,
"type": <hubtype>,
"hubId": <hubID>,
"provisioningState": <provisioningstate>
}
}
En la tabla siguiente se describen los elementos del cuerpo de respuesta.
Nombre del elemento | Descripción |
---|---|
name | Nombre del centro |
ComputeMethod | Método de cálculo de este centro. |
type | El tipo del centro |
hubID | Identificador generado automáticamente para este centro. |
ProvisioningState | Especifica el estado de aprovisionamiento actual del centro. Cuando se crea correctamente una centro, el valor del elemento es Correcto. |
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/hubs/hubtest?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 el siguiente cuerpo:
{
"name": "Hubtest",
"properties":
{
"defaultCompute": "SampleDefaultCompute",
"type": "Hub"
}
}
Una vez enviada la solicitud, se devuelve la respuesta siguiente:
Encabezado:
Status Code:
Created
Headers:
Pragma : no-cache
x-ms-request-id : 00000000-1111-1111-1111-000000000000
x-ms-ratelimit-remaining-subscription-writes: 11996
x-ms-correlation-request-id : 00000000-1111-2222-1111-000000000000
x-ms-routing-request-id : WESTUS:20141203T214448Z: 00000000-1111-2222-1111-000000000000
Strict-Transport-Security : max-age=31536000; includeSubDomains
Cache-Control : no-cache
Date : Wed, 03 Dec 2014 21:44:48 GMT
Location : https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/adf/providers/Microsoft.DataFactory/datafactories/test/hubs/hubtest?api-version=2015-10-01
Server : Microsoft-IIS/8.5
X-Powered-By : ASP.NET
Cuerpo:
{
"name": "Hubtest",
"properties":
{
"defaultCompute": "SampleDefaultCompute",
"type": "Hub",
"hubId": "c4753e2a-4297-49ab-8269-ca4378ae4e37",
"provisioningState": "Succeeded"
}
}
Eliminar
Elimina el centro específico.
Request
La solicitud Eliminar centro 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}/hubs/{HubName}?api-version={api-version} | HTTP/1.1 |
Parámetros de identificador URI
Parámetro de URI | Obligatorio | Descripción |
---|---|---|
SubscriptionID | Sí | El identificador de suscripción a 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 en la que desea eliminar el centro. |
HubName | Sí | Nombre del centro que desea eliminar. |
Api-Version | Sí | Versión de la API de PowerShell/SDK de C# |
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
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. |
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/hubs/hubtest?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: 799992
x-ms-correlation-request-id : 00000000-1111-2222-1111-000000000000
x-ms-routing-request-id : WESTUS:20141203T214448Z: 00000000-1111-2222-1111-000000000000
Strict-Transport-Security : max-age=31536000; includeSubDomains
Cache-Control : no-cache
Date : Wed, 03 Dec 2014 21:44:48 GMT
Server : Microsoft-IIS/8.5
X-Powered-By : ASP.NET
client-tracking-id : 66
Obtener
Obtiene información sobre un centro existente.
Request
La solicitud Obtener centro 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}/hubs/{HubName}?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 donde desea obtener el centro. |
HubName | Sí | Nombre del centro 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 | 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 especificado 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. |
Cuerpo de la respuesta
El cuerpo de la solicitud depende del tipo de centro.
{
"name": <name>,
"properties": {
"defaultCompute": <computemethod>,
"type": <hubtype>,
"hubId": <hubID>,
"provisioningState": <provisioningstate>
}
}
En la tabla siguiente se describen los elementos del cuerpo de respuesta.
Nombre del elemento | Descripción |
---|---|
name | Nombre del concentrador. |
Computemethod | Método de cálculo de este centro. |
type | El tipo del centro. |
hubID | Identificador generado automáticamente para este centro. |
ProvisioningState | Especifica el estado de aprovisionamiento actual del centro. Cuando se crea correctamente una centro, el valor del elemento es Correcto. |
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/hubs/hubtest?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: 799992
x-ms-correlation-request-id : 00000000-1111-2222-1111-000000000000
x-ms-routing-request-id : WESTUS:20141203T214448Z: 00000000-1111-2222-1111-000000000000
Strict-Transport-Security : max-age=31536000; includeSubDomains
Cache-Control : no-cache
Date : Wed, 03 Dec 2014 21:44:48 GMT
Server : Microsoft-IIS/8.5
X-Powered-By : ASP.NET
The response includes the following XML body.
{
"name": "Hubtest",
"properties": {
"type": "Hub",
"hubId": "c4753e2a-4297-49ab-8269-ca4378ae4e37",
"provisioningState": "Succeeded"
}
}
List
Muestra información sobre todos los centros de la factoría de datos.
Request
La solicitud Enumerar centros 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}/hubs?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 donde desea ubicar el centro. |
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
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 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
{
"value": [
{
"name": <name1>,
"properties": {
"type": <hubtype>,
"hubId": <hubID>,
"provisioningState": <provisioningstate>
}
},
{
"name": <name2>,
"properties": {
"defaultCompute": <computemethod>,
"type": <hubtype>,
"hubId": <hubID>,
"provisioningState": <provisioningstate>
}
}
]
}
En la tabla siguiente se describen los elementos del cuerpo de respuesta.
Nombre del elemento | Descripción |
---|---|
name | Nombre del concentrador. |
Computemethod | Método de cálculo de este centro. |
type | El tipo del centro |
hubID | Identificador generado automáticamente para este centro |
ProvisioningState | Especifica el estado de aprovisionamiento actual del centro. Cuando se crea correctamente una centro, el valor del elemento es Correcto. |
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/hubs?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: 799992
x-ms-correlation-request-id : 00000000-1111-2222-1111-000000000000
x-ms-routing-request-id : WESTUS:20141203T214448Z: 00000000-1111-2222-1111-000000000000
Strict-Transport-Security : max-age=31536000; includeSubDomains
Cache-Control : no-cache
Date : Wed, 03 Dec 2014 21:44:48 GMT
Server : Microsoft-IIS/8.5
X-Powered-By : ASP.NET
The response includes the following XML body.
{
"value": [
{
"name": "hubtest",
"properties": {
"type": "InternalHub",
"hubId": "39d4e663-cfcb-4ee9-ad19-92cf87de9197",
"provisioningState": "Succeeded"
}
},
{
"name": "hubtest2",
"properties": {
"defaultCompute": "SampleDefaultCompute",
"type": "Hub",
"hubId": "c4753e2a-4297-49ab-8269-ca4378ae4e37",
"provisioningState": "Succeeded"
}
}
]
}