Versión 1 de la puerta de enlace (V1)

Artículo
07/19/2023

Nota:

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

Crear

Crea una nueva puerta de enlace.

Request

La solicitud Crear o actualizar puerta de enlace 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}/gateways/{GatewayName}?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 en la que desea crear la puerta de enlace.
GatewayName	Sí	Nombre de la puerta de enlace 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 formato del cuerpo de la solicitud es el siguiente.

  
{  
    "name": <name>,  
    "properties": {  
        "description": <description>  
    }  
}

En la tabla siguiente se describen los elementos del cuerpo de la solicitud.

Nombre del elemento	Obligatorio	Descripción
name	Sí	Nombre de la puerta de enlace.
description	No	Descripción de la puerta de enlace.

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.

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 otros se puedan correlacionar a través de Azure.
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

Cuerpo de la respuesta

  
{  
    "location": <location>,  
    "name": <name>,  
    "properties": {  
        "key": <key>,  
        "description": <description>,  
        "hostServiceUri": <hostServiceUri>,  
        "dataFactoryName": <dataFactoryName>,  
        "status": <status>,  
        "versionStatus": <versionStatus>,  
        "provisioningState": <provisioningState>,  
        "version": <version>,  
        "createTime": <createTime>,  
        "registerTime": <registerTime>,  
        "lastConnectTime": <lastConnectTime>,  
        "expiryTime": <expiryTime>  
    }  
}

En la tabla siguiente se describen los elementos del cuerpo de respuesta.

Nombre del elemento	Descripción
name	Nombre de la puerta de enlace.
ubicación	Ubicación de la puerta de enlace.
key	Clave de la puerta de enlace usada para el registro.
description	Descripción de la puerta de enlace.
hostServiceUri	URI para el equipo host de la puerta de enlace
dataFactoryName	Nombre de la factoría de datos a la que pertenece la puerta de enlace.
status	Estado de la puerta de enlace. Los valores pueden Online, Offline o NeedRegistration.
versionStatus	Estado de la versión de puerta de enlace. Los valores pueden ser UpToDate, Expiring, Expired, NewVersionAvailable y None.
provisioningState	Especifica el estado de aprovisionamiento actual del servicio vinculado. Cuando se crea correctamente un servicio vinculado, el valor del elemento es Correcto.
version	Versión de la puerta de enlace
createTime	La hora en que se creó la puerta de enlace.
registerTime	La hora en que se registró la puerta de enlace.
expiryTime	La hora en que expirará la puerta de enlace.
lastConnectTime	La hora de última conexión de la puerta de enlace.

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/gateways/gatewaytest?api-version=2015-10-01

La solicitud se envía con los encabezados siguientes.

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

Y con el siguiente cuerpo.

  
{  
    "name": "gatewaytest",  
    "properties": {  
        "description": "test description."  
    }  
}

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: 11999  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : WESTUS:20141203T213044Z: 00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Wed, 03 Dec 2014 21:30:44 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET

La respuesta incluye el siguiente cuerpo XML.

  
{  
    "location": "West US",  
    "name": "gatewaytest",  
    "properties": {  
        "key": "ADF#066b1a89-e84f-47a4-a784-a753b2e06623@21a6600e-6a83-4734-9a7a-b2a6b791b129@317515fd-a26a-4a08-a2f5-c13fb49b3851@wu#11gTEsN4o12bfYN26qbjlJMgihOlX7hyYAmrPwtLCRU=",  
        "description": "test description.",  
        "hostServiceUri": null,  
        "dataFactoryName": "test",  
        "status": "NeedRegistration",  
        "versionStatus": "None",  
        "provisioningState": "Succeeded",  
        "version": null,  
        "createTime": "2015-12-18T07:04:13.00664Z",  
        "registerTime": null,  
        "lastConnectTime": null,  
        "expiryTime": null  
    }  
}

Eliminar

Elimina la puerta de enlace específica.

Request

La solicitud Eliminar puerta de enlace 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}/gateways/{GatewayName}?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 en la que desea crear la puerta de enlace.
GatewayName	Sí	Nombre de la puerta de enlace 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

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

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/gateways/gatewaytest?api-version=2014-12-01-preview

La solicitud se envía con los encabezados siguientes.

  
x-ms-client-request-id: 00000000-0000-0000-0000-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: 11999  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : WESTUS:20141203T213044Z: 00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Wed, 03 Dec 2014 21:30:44 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET

Obtener

Obtiene información sobre una puerta de enlace existente.

Request

La solicitud Obtener puerta de enlace 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}/gateways/{GatewayName}?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 en la que desea crear la puerta de enlace.
GatewayName	Sí	Nombre de la puerta de enlace 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

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, el grupo de recursos o la puerta de enlace 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

Cuerpo de la respuesta

  
{  
    "name": <name>,  
    "properties": {  
        "key": null,  
        "description": <description>,  
        "hostServiceUri": <hostServiceUri>,  
        "dataFactoryName": <dataFactoryName>,  
        "status": <status>,  
        "versionStatus": <versionStatus>,  
        "provisioningState": <provisioningState>,  
        "version": <version>,  
        "createTime": <createTime>,  
        "registerTime": <registerTime>,  
        "lastConnectTime": <lastConnectTime>,  
        "expiryTime": <expiryTime>  
    },  
    "id": <ID>  
}

En la tabla siguiente se describen los elementos del cuerpo de respuesta.

Nombre del elemento	Descripción
name	Nombre de la puerta de enlace.
ubicación	Ubicación de la puerta de enlace.
key	Clave de la puerta de enlace usada para el registro. El valor siempre será Null en la operación GET, debido a que no se puede recuperar la clave.
description	Descripción de la puerta de enlace.
hostServiceUri	URI para tener acceso al equipo host de la puerta de enlace.
dataFactoryName	Nombre de la factoría de datos a la que pertenece la puerta de enlace.
status	El estado de la puerta de enlace, que puede ser Online, Offline o NeedRegistration.
versionStatus	Estado de la versión de la puerta de enlace, que puede ser UpToDate, Expiring, Expired, NewVersionAvailable y None.
provisioningState	Especifica el estado de aprovisionamiento actual del servicio vinculado. Cuando se crea correctamente un servicio vinculado, el valor del elemento es Correcto.
version	Versión de la puerta de enlace.
createTime	La hora en que se creó la puerta de enlace.
registerTime	La hora en que se registró la puerta de enlace.
expiryTime	La hora en que expirará la puerta de enlace.
lastConnectTime	La hora de última conexión de la puerta de enlace.

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/SPRestDataFactory/gateways/SPGateway?api-version=2015-10-01

La solicitud se envía con los encabezados siguientes.

x-ms-client-request-id: 00000000-0000-0000-0000-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: 11999  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : WESTUS:20141203T213044Z: 00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Wed, 03 Dec 2014 21:30:44 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET

La respuesta incluye el siguiente cuerpo XML.

  
{  
  "value": [  
    {  
      "name": "SPGateway",  
      "properties": {  
        "hostServiceUri": "https://{machine>.<domain>.corp.<company>.com:8050/HostServiceRemote.svc/",  
        "dataFactoryName": "sprestdatafactory",  
        "status": "Online",  
        "versionStatus": "UpToDate",  
        "provisioningState": "Succeeded",  
        "version": "1.9.5865.2",  
        "createTime": "2016-02-24T18:55:03.1149963Z",  
        "registerTime": "2016-02-24T18:56:13.299978Z",  
        "lastConnectTime": "2016-02-24T18:57:07.6144045Z"  
      },  
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ADF/providers/Microsoft.DataFactory/datafactories/SPRestDataFactory/gateways/SPGateway"  
    }  
  ]  
}

List

Muestra información de todas las puertas de enlace de la factoría de datos.

Request

La solicitud Enumerar puertas de enlace 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}/gateways?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 en la que desea crear la puerta de enlace.
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

Cuerpo de la respuesta

  
{  
    "value":[    
    {  
        "name": <name>,  
        "properties": {  
            "key": null,  
            "description": <description>,  
            "hostServiceUri": <hostServiceUri>,  
            "dataFactoryName": <dataFactoryName>,  
            "status": <status>,  
            "versionStatus": <versionStatus>,  
            "provisioningState": <provisioningState>,  
            "version": <version>,  
            "createTime": <createTime>,  
            "registerTime": <registerTime>,  
            "lastConnectTime": <lastConnectTime>,  
            "expiryTime": <expiryTime>  
        }  
    },  
    {  
        "name": <name>,  
        "properties": {  
            "key": null,  
            "description": <description>,  
            "hostServiceUri": <hostServiceUri>,  
            "dataFactoryName": <dataFactoryName>,  
            "status": <status>,  
            "versionStatus": <versionStatus>,  
            "provisioningState": <provisioningState>,  
            "version": <version>,  
            "createTime": <createTime>,  
            "registerTime": <registerTime>,  
            "lastConnectTime": <lastConnectTime>,  
            "expiryTime": <expiryTime>  
        }  
    ]  
}

En la tabla siguiente se describen los elementos del cuerpo de respuesta.

Nombre del elemento	Descripción
name	Nombre de la puerta de enlace.
ubicación	Ubicación de la puerta de enlace.
key	Clave de la puerta de enlace usada para el registro.
description	Descripción de la puerta de enlace.
hostServiceUri	URI para tener acceso al equipo host de la puerta de enlace
dataFactoryName	Nombre de la factoría de datos a la que pertenece la puerta de enlace.
status	Estado de la puerta de enlace, que puede ser En línea, Sin conexión o NeedRegistration
versionStatus	Estado de la versión de la puerta de enlace, que puede ser UpToDate, Expiring, Expired, NewVersionAvailable y None.
provisioningState	Especifica el estado de aprovisionamiento actual del servicio vinculado. Cuando se crea correctamente un servicio vinculado, el valor del elemento es Correcto.
version	Versión de la puerta de enlace.
createTime	La hora en que se creó la puerta de enlace.
registerTime	La hora en que se registró la puerta de enlace.
expiryTime	La hora en que expirará la puerta de enlace.
lastConnectTime	La hora de última conexión de la puerta de enlace.

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/SPRestDataFactory/gateways?api-version=2015-10-01

La solicitud se envía con los encabezados siguientes.

x-ms-client-request-id: 00000000-0000-0000-0000-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: 11999  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : WESTUS:20141203T213044Z: 00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Wed, 03 Dec 2014 21:30:44 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET

La respuesta incluye el siguiente cuerpo XML.

  
{  
  "value": [  
    {  
      "name": "SPGateway",  
      "properties": {  
        "hostServiceUri": "https://{machine>.<domain>.corp.<company>.com:8050/HostServiceRemote.svc/",  
        "dataFactoryName": "sprestdatafactory",  
        "status": "Online",  
        "versionStatus": "UpToDate",  
        "provisioningState": "Succeeded",  
        "version": "1.9.5865.2",  
        "createTime": "2016-02-24T18:55:03.1149963Z",  
        "registerTime": "2016-02-24T18:56:13.299978Z",  
        "lastConnectTime": "2016-02-24T19:06:40.1454525Z"  
      },  
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ADF/providers/Microsoft.DataFactory/datafactories/SPRestDataFactory/gateways/SPGateway"  
    },  
    {  
      "name": "SPGateway2",  
      "properties": {  
        "hostServiceUri": "https://{machine>.<domain>.corp.<company>.com:8050/HostServiceRemote.svc/",  
        "dataFactoryName": "sprestdatafactory",  
        "status": "Online",  
        "versionStatus": "UpToDate",  
        "provisioningState": "Succeeded",  
        "version": "1.9.5865.2",  
        "createTime": "2016-02-24T18:55:03.1149963Z",  
        "registerTime": "2016-02-24T18:56:13.299978Z",  
        "lastConnectTime": "2016-02-24T19:06:40.1454525Z"  
      },  
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ADF/providers/Microsoft.DataFactory/datafactories/SPRestDataFactory/gateways/SPGateway"  
    }  
  ]  
}

Regenerar clave

Renega una nueva clave para una puerta de enlace existente que reemplaza la clave anterior.

Request

La solicitud Regenerar clave de puerta de enlace 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}/gateways/{GatewayName}/regeneratekey?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 en la que desea crear la puerta de enlace.
GatewayName	Sí	Nombre de la puerta de enlace 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

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

Cuerpo de la respuesta

  
{  
    "key": <key>  
}

En la tabla siguiente se describen los elementos del cuerpo de respuesta.

Nombre del elemento	Descripción
key	Clave de la puerta de enlace usada para el registro

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/gateways/gatewaytest/regeneratekey?api-version=2015-10-01

La solicitud se envía con los encabezados siguientes.

  
x-ms-client-request-id: 00000000-0000-0000-0000-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: 11999  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : WESTUS:20141203T213044Z: 00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Wed, 03 Dec 2014 21:30:44 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET

La respuesta incluye el siguiente cuerpo XML.

  
{  
    "key": " ADF#066b1a89-e84f-47a4-a784-a753b2e06623@21a6600e-6a83-4734-9a7a-b2a6b791b129@317515fd-a26a-4a08-a2f5-c13fb49b3851@wu#11gTEsN4o12bfYN26qbjlJMgihOlX7hyYAmrPwtLCRU="  
}

Actualizar

Novedades el contenido de una puerta de enlace existente.

Request

La solicitud Actualizar puerta de enlace se puede construir de la siguiente manera (se recomienda HTTPS):

Verbo HTTP	URI de solicitud	Versión HTTP
PATCH	https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/gateways/{GatewayName}?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 la puerta de enlace.
GatewayName	Sí	Nombre de la puerta de enlace 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 formato del cuerpo de la solicitud es el siguiente:

  
{  
    "properties": {  
        "description": <description>  
    }  
}

En la tabla siguiente se describen los elementos del cuerpo de la solicitud.

Nombre del elemento	Obligatorio	Descripción
description	No	Descripción de la puerta de enlace.

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

Cuerpo de la respuesta

  
{  
    "name": <name>,  
    "properties": {  
        "key": null  
        "description": <description>,  
        "hostServiceUri": <hostServiceUri>,  
        "dataFactoryName": <dataFactoryName>,  
        "status": <status>,  
        "versionStatus": <versionStatus>,  
        "provisioningState": <provisioningState>,  
        "version": <version>,  
        "createTime": <createTime>,  
        "registerTime": <registerTime>,  
        "lastConnectTime": <lastConnectTime>,  
        "expiryTime": <expiryTime>  
    }  
}

En la tabla siguiente se describen los elementos del cuerpo de respuesta.

Nombre del elemento	Descripción
name	Nombre de la puerta de enlace.
ubicación	Ubicación de la puerta de enlace.
key	Clave de la puerta de enlace usada para el registro.
description	Descripción de la puerta de enlace.
hostServiceUri	URI para tener acceso al equipo host de la puerta de enlace.
dataFactoryName	Nombre de la factoría de datos a la que pertenece la puerta de enlace.
status	El estado de la puerta de enlace, que puede ser Online, Offline o NeedRegistration.
versionStatus	Estado de la versión de la puerta de enlace, que puede ser UpToDate, Expiring, Expired, NewVersionAvailable y None.
provisioningState	Especifica el estado de aprovisionamiento actual del servicio vinculado. Cuando se crea correctamente un servicio vinculado, el valor del elemento es Correcto.
version	Versión de la puerta de enlace.
createTime	La hora en que se creó la puerta de enlace.
registerTime	La hora en que se registró la puerta de enlace.
expiryTime	La hora en que expirará la puerta de enlace.
lastConnectTime	La hora de última conexión de la puerta de enlace.

Solicitud y respuesta de ejemplo

URI de ejemplo:

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

La solicitud se envía con los encabezados siguientes.

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

y con el siguiente cuerpo:

  
{  
"properties": {  
    "description": "test description."  
}  
}

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: 11999  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : WESTUS:20141203T213044Z: 00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Wed, 03 Dec 2014 21:30:44 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET

La respuesta incluye el siguiente cuerpo XML.

  
{  
    "name": "gatewaytest",  
    "properties": {  
        "key": null,  
        "description": "test description.",  
        "hostServiceUri": null,  
        "dataFactoryName": "test",  
        "status": "NeedRegistration",  
        "versionStatus": "None",  
        "provisioningState": "Succeeded",  
        "version": null,  
        "createTime": "2015-12-18T07:04:13.00664Z",  
        "registerTime": null,  
        "lastConnectTime": null,  
        "expiryTime": null  
    }  
}

Compartir a través de

Versión 1 de la puerta de enlace (V1)

Crear

Request

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

Request

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

Obtener

Request

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

Request

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

Regenerar clave

Request

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

Actualizar

Request

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