你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

网关版本 1 (V1)

项目
07/19/2023

注意

本参考文档适用于Azure 数据工厂版本 1 (V1) 。

创建

创建新网关。

请求

Create Gateway 或 Update Gateway 请求可以按如下方式构造（建议使用 HTTPS）：

HTTP 谓词	请求 URI	HTTP 版本
PUT	https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/gateways/{GatewayName}?api-version={api-version}	HTTP/1.1

URI 参数

URI 参数	必需	说明
订阅 ID	是	Azure 订阅 ID。
ResourceGroupName	是	托管 Azure 数据工厂的资源组的唯一名称。
DataFactoryName	是	你要在其中创建网关的数据工厂的名称。
GatewayName	是	你要创建的网关的名称
API 版本	是	指定用于发出此请求的协议的版本。

请求标头

下表介绍请求标头。

请求头	必需	说明
x-ms-client-request-id	是	此请求的操作 ID。

请求正文

请求正文的格式如下所示。

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

下表说明了请求正文的元素。

元素名称	必需	说明
name	是	网关的名称。
description	否	网关的说明。

响应

响应包括 HTTP 状态代码、一组响应标头和响应正文。

状态代码

200（正常）- 如果请求已成功完成。
202（已接受）- 如果已接受请求。
400（错误的请求）- 如果请求正文未通过验证。
404（找不到）- 如果订阅或资源组不存在。
412（不满足前提条件）- 如果不满足 If-Match 标头指定的条件。

响应标头

此操作的响应包括以下标头。该响应还可能包括其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范。

响应标头	说明
x-ms-request-id	当前操作的唯一标识符，由服务生成。
x-ms-ratelimit-remaining-subscription-writes	当前订阅的剩余限制。
x-ms-correlation-request-id	指定请求的跟踪相关 ID。资源提供程序必须记录此项，以便可以通过 Azure 关联端到端请求。
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

响应正文

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

下表介绍响应正文的元素。

元素名称	说明
name	网关的名称。
location	网关的位置。
key	用于注册的网关密钥。
description	网关的说明。
hostServiceUri	网关主机的 URI
dataFactoryName	网关所属的数据工厂的名称。
状态	网关的状态。值可以是 Online、Offline 或 NeedRegistration。
versionStatus	网关版本的状态。值可以是 UpToDate、Expiring、Expired、NewVersionAvailable 和 None。
provisioningState	指定链接服务的当前设置状态。成功创建链接服务时，此元素的值为 Succeeded。
version	网关的版本
createTime	网关的创建时间。
registerTime	网关的注册时间。
expiryTime	网关的到期时间。
lastConnectTime	上次连接网关的时间。

示例请求和响应

示例 URI：

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

该请求与以下标头一起发送。

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

并与以下正文发送。

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

在发送请求后，将返回以下响应。

  
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

响应包括以下 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  
    }  
}

删除

删除特定网关。

请求

可以按如下方式构造“删除网关”请求（建议使用 HTTPS）：

HTTP 谓词	请求 URI	HTTP 版本
DELETE	https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/gateways/{GatewayName}?api-version={api-version}	HTTP/1.1

URI 参数

URI 参数	必需	说明
订阅 ID	是	Azure 订阅 ID。
ResourceGroupName	是	托管 Azure 数据工厂的资源组的唯一名称。
DataFactoryName	是	你要在其中创建网关的数据工厂的名称。
GatewayName	是	要创建的网关的名称。
API 版本	是	指定用于发出此请求的协议的版本。

请求标头

下表介绍请求标头。

请求头	必需	说明
x-ms-client-request-id	是	此请求的操作 ID。

请求正文

无。

响应

响应包括 HTTP 状态代码、一组响应标头和响应正文。

状态代码

200（正常）- 如果请求已成功完成。
400（错误的请求）- 如果请求正文未通过验证。
404（找不到）- 如果订阅或资源组不存在。
412（不满足前提条件）- 如果不满足 If-Match 标头指定的条件。

响应标头

此操作的响应包括以下标头。该响应还可能包括其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范。

响应标头	说明
x-ms-request-id	当前操作的唯一标识符，由服务生成。
x-ms-ratelimit-remaining-subscription-writes	当前订阅的剩余限制。
x-ms-correlation-request-id	指定请求的跟踪相关 ID。资源提供程序必须记录此项，以便可以通过 Azure 关联端到端请求。
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

响应正文

无。

示例请求和响应

示例 URI：

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

该请求与以下标头一起发送。

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

在发送请求后，将返回以下响应。

  
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

获取

获取有关现有网关的信息。

请求

Get Gateway 请求可以按如下方式构造（建议使用 HTTPS）：

HTTP 谓词	请求 URI	HTTP 版本
GET	https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/gateways/{GatewayName}?api-version={api-version}	HTTP/1.1

URI 参数

URI 参数	必需	说明
订阅 ID	是	Azure 订阅 ID。
ResourceGroupName	是	托管 Azure 数据工厂的资源组的唯一名称。
DataFactoryName	是	你要在其中创建网关的数据工厂的名称。
GatewayName	是	要创建的网关的名称。
API 版本	是	指定用于发出此请求的协议的版本。

请求标头

下表介绍请求标头。

请求头	必需	说明
x-ms-client-request-id	是	此请求的操作 ID。

请求正文

无。

响应

响应包括 HTTP 状态代码、一组响应标头和响应正文。

状态代码

200（正常）- 如果请求已成功完成。
400（错误的请求）- 如果请求正文未通过验证。
404（找不到）- 如果订阅、资源组或网关不存在。
412（不满足前提条件）- 如果不满足 If-Match 标头指定的条件。

响应标头

此操作的响应包括以下标头。该响应还可能包括其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范。

响应标头	说明
x-ms-request-id	当前操作的唯一标识符，由服务生成。
x-ms-ratelimit-remaining-subscription-writes	当前订阅的剩余限制。
x-ms-correlation-request-id	指定请求的跟踪相关 ID。资源提供程序必须记录此项，以便可以通过 Azure 关联端到端请求。
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

响应正文

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

下表介绍响应正文的元素。

元素名称	说明
name	网关的名称。
location	网关的位置。
key	用于注册的网关密钥。它将在 get 操作中始终为 null，因为无法检索密钥。
description	网关的说明。
hostServiceUri	用于访问网关的主机的 URI。
dataFactoryName	网关所属的数据工厂的名称。
状态	网关的状态，可以是 Online、Offline 或 NeedRegistration。
versionStatus	网关版本的状态，可以是 UpToDate、Expiring、Expired、NewVersionAvailable 和 None。
provisioningState	指定链接服务的当前设置状态。成功创建链接服务时，此元素的值为 Succeeded。
version	网关的版本。
createTime	网关的创建时间。
registerTime	网关的注册时间。
expiryTime	网关的到期时间。
lastConnectTime	上次连接网关的时间。

示例请求和响应

示例 URI：

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

该请求与以下标头一起发送。

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

在发送请求后，将返回以下响应。

  
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

响应包括以下 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"  
    }  
  ]  
}

列出

列出数据工厂中所有网关的信息。

请求

可以按如下方式构造“列出网关”请求（建议使用 HTTPS）：

HTTP 谓词	请求 URI	HTTP 版本
GET	https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/gateways?api-version={api-version}	HTTP/1.1

URI 参数

URI 参数	必需	说明
订阅 ID	是	Azure 订阅 ID。
ResourceGroupName	是	托管 Azure 数据工厂的资源组的唯一名称。
DataFactoryName	是	你要在其中创建网关的数据工厂的名称。
API 版本	是	指定用于发出此请求的协议的版本。

请求标头

下表介绍请求标头。

请求头	必需	说明
x-ms-client-request-id	是	此请求的操作 ID。

请求正文

无。

响应

响应包括 HTTP 状态代码、一组响应标头和响应正文。

状态代码

200（正常）- 如果请求已成功完成。
400（错误的请求）- 如果请求正文未通过验证。
404（找不到）- 如果订阅或资源组不存在。
412（不满足前提条件）- 如果不满足 If-Match 标头指定的条件。

响应标头

此操作的响应包括以下标头。该响应还可能包括其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范。

响应标头	说明
x-ms-request-id	当前操作的唯一标识符，由服务生成。
x-ms-ratelimit-remaining-subscription-writes	当前订阅的剩余限制。
x-ms-correlation-request-id	指定请求的跟踪相关 ID。资源提供程序必须记录此项，以便可以通过 Azure 关联端到端请求。
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

响应正文

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

下表介绍响应正文的元素。

元素名称	说明
name	网关的名称。
location	网关的位置。
key	用于注册的网关密钥。
description	网关的说明。
hostServiceUri	用于访问网关主机的 URI
dataFactoryName	网关所属的数据工厂的名称。
状态	网关的状态，可以是“联机”、“脱机”或“NeedRegistration”
versionStatus	网关版本的状态，可以是 UpToDate、Expiring、Expired、NewVersionAvailable 和 None。
provisioningState	指定链接服务的当前设置状态。成功创建链接服务时，此元素的值为 Succeeded。
version	网关的版本。
createTime	网关的创建时间。
registerTime	网关的注册时间。
expiryTime	网关的到期时间。
lastConnectTime	上次连接网关的时间。

示例请求和响应

示例 URI：

PUT: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ADF/providers/Microsoft.DataFactory/datafactories/SPRestDataFactory/gateways?api-version=2015-10-01

该请求与以下标头一起发送。

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

在发送请求后，将返回以下响应。

  
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

响应包括以下 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"  
    }  
  ]  
}

重新生成密钥

为替换旧密钥的现有网关重新添加新密钥。

请求

Regenerate Gateway Key 请求可以按如下方式构造（建议使用 HTTPS）：

HTTP 谓词	请求 URI	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

URI 参数

URI 参数	必需	说明
订阅 ID	是	Azure 订阅 ID。
ResourceGroupName	是	托管 Azure 数据工厂的资源组的唯一名称。
DataFactoryName	是	你要在其中创建网关的数据工厂的名称。
GatewayName	是	要创建的网关的名称。
API 版本	是	指定用于发出此请求的协议的版本。

请求标头

下表介绍请求标头。

请求头	必需	说明
x-ms-client-request-id	是	此请求的操作 ID。

请求正文

无。

响应

响应包括 HTTP 状态代码、一组响应标头和响应正文。

状态代码

200（正常）- 如果请求已成功完成。
400（错误的请求）- 如果请求正文未通过验证。
404（找不到）- 如果订阅或资源组不存在。
412（不满足前提条件）- 如果不满足 If-Match 标头指定的条件。

响应标头

此操作的响应包括以下标头。该响应还可能包括其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范。

响应标头	说明
x-ms-request-id	当前操作的唯一标识符，由服务生成。
x-ms-ratelimit-remaining-subscription-writes	当前订阅的剩余限制。
x-ms-correlation-request-id	指定请求的跟踪相关 ID。资源提供程序必须记录此项，以便可以通过 Azure 关联端到端请求。
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

响应正文

  
{  
    "key": <key>  
}

下表介绍响应正文的元素。

元素名称	说明
key	用于注册的网关的密钥

示例请求和响应

示例 URI：

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

该请求与以下标头一起发送。

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

在发送请求后，将返回以下响应。

  
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

响应包括以下 XML 正文。

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

更新

汇报现有网关的内容。

请求

可以按如下方式构造“更新网关”请求（建议使用 HTTPS）：

HTTP 谓词	请求 URI	HTTP 版本
修补程序	https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/gateways/{GatewayName}?api-version={api-version}	HTTP/1.1

URI 参数

URI 参数	必需	说明
订阅 ID	是	Azure 订阅 ID。
ResourceGroupName	是	托管 Azure 数据工厂服务的资源组的唯一名称。
DataFactoryName	是	你要在其中创建网关的数据工厂的名称。
GatewayName	是	要创建的网关的名称。
API 版本	是	指定用于发出此请求的协议的版本。

请求标头

下表介绍请求标头。

请求头	必需	说明
x-ms-client-request-id	是	此请求的操作 ID。

请求正文

请求正文的格式如下所示：

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

下表说明了请求正文的元素。

元素名称	必需	说明
description	否	网关的说明。

响应

响应包括 HTTP 状态代码、一组响应标头和响应正文。

状态代码

200（正常）- 如果请求已成功完成。
400（错误的请求）- 如果请求正文未通过验证。
404（找不到）- 如果订阅或资源组不存在。
412（不满足前提条件）- 如果不满足 If-Match 标头指定的条件。

响应标头

此操作的响应包括以下标头。该响应还可能包括其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范。

响应标头	说明
x-ms-request-id	当前操作的唯一标识符，由服务生成。
x-ms-ratelimit-remaining-subscription-writes	当前订阅的剩余限制。
x-ms-correlation-request-id	指定请求的跟踪相关 ID。资源提供程序必须记录此项，以便可以通过 Azure 关联端到端请求。
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

响应正文

  
{  
    "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	网关的名称。
location	网关的位置。
key	用于注册的网关密钥。
description	网关的说明。
hostServiceUri	用于访问网关主机的 URI。
dataFactoryName	网关所属的数据工厂的名称。
状态	网关的状态，可以是 Online、Offline 或 NeedRegistration。
versionStatus	网关版本的状态，可以是 UpToDate、Expiring、Expired、NewVersionAvailable 和 None。
provisioningState	指定链接服务的当前设置状态。成功创建链接服务时，此元素的值为 Succeeded。
version	网关的版本。
createTime	网关的创建时间。
registerTime	网关的注册时间。
expiryTime	网关的到期时间。
lastConnectTime	上次连接网关的时间。

示例请求和响应

示例 URI：

  
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

该请求与以下标头一起发送。

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

并包含以下正文：

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

在发送请求后，将返回以下响应。

  
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

响应包括以下 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  
    }  
}

网关版本 1 (V1)

创建

请求

URI 参数

请求标头

请求正文

响应

状态代码

响应标头

响应正文

示例请求和响应

删除

请求

URI 参数

请求标头

请求正文

响应

状态代码

响应标头

响应正文

示例请求和响应

获取

请求

URI 参数

请求标头

请求正文

响应

状态代码

响应标头

响应正文

示例请求和响应

列出

请求

URI 参数

请求标头

请求正文

响应

状态代码

响应标头

响应正文

示例请求和响应

重新生成密钥

请求

URI 参数

请求标头

请求正文

响应

状态代码

响应标头

响应正文

示例请求和响应

更新

请求

URI 参数

请求标头

请求正文

响应

状态代码

响应标头

响应正文

示例请求和响应

其他资源