你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
中心版本 1 (V1)
注意
此参考文档适用于Azure 数据工厂版本 1 (V1) 。
创建或更新
创建新的中心,或更新现有中心的内容。
请求
可以按如下方式构造“创建或更新集线器”请求(建议使用 HTTPS):
HTTP 谓词 | 请求 URI | HTTP 版本 |
---|---|---|
PUT | https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/hubs/{HubName}?api-version={api-version} | HTTP/1.1 |
URI 参数
URI 参数 | 必需 | 说明 |
---|---|---|
订阅 ID | 是 | Azure 订阅 ID。 |
ResourceGroupName | 是 | 托管 Azure 数据工厂服务的资源组的唯一名称。 |
DataFactoryName | 是 | 你想要在其中创建集线器的数据工厂的名称。 |
HubName | 是 | 要创建的集线器的名称。 |
API 版本 | 是 | 指定用于发出此请求的协议的版本。 |
请求标头
下表介绍请求标头。
请求头 | 必需 | 说明 |
---|---|---|
x-ms-client-request-id | 是 | 此请求的操作 ID。 |
请求正文
请求正文取决于集线器类型。 请求正文的格式如下所示:
{
"name": <hubname>,
"properties": {
"defaultCompute": <computemethod>,
"type": <hubtype>
}
}
下表说明了请求正文的元素。
元素名称 | 必需 | 说明 |
---|---|---|
name | 是 | 集线器的名称。 |
properties | 是 | 集线器的属性。 |
响应
响应包括 HTTP 状态代码、一组响应标头和响应正文。
状态代码
200(正常)- 请求成功完成。
202(已接受)- 已接受请求。
400(错误的请求)- 请求正文未通过验证。
404(找不到)- 订阅或资源组或数据工厂不存在。
412(不满足前提条件)- 不满足 If-Match 标头指定的条件。
501(未实现)- 未实现验证
响应标头
此操作的响应包括以下标头。 该响应还可能包括其他标准 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 |
日期 | 服务生成的 UTC 日期/时间值指示启动响应的时间。 |
位置 | 要创建或获取的对象的 URI。 |
响应正文
{
"name": <name>,
"properties":
{
"defaultCompute": <computemethod>,
"type": <hubtype>,
"hubId": <hubID>,
"provisioningState": <provisioningstate>
}
}
下表介绍响应正文的元素。
元素名称 | 说明 |
---|---|
name | 集线器的名称 |
ComputeMethod | 此集线器的计算方法。 |
type | 集线器的类型 |
hubID | 为此集线器自动生成的 ID。 |
ProvisioningState | 指定集线器的当前设置状态。 成功创建集线器时,此元素的值为 Succeeded |
示例请求和响应
示例 URI:
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
请求与以下标头一起发送:
x-ms-client-request-id : 00000000-1111-1111-1111-000000000000
并包含以下正文:
{
"name": "Hubtest",
"properties":
{
"defaultCompute": "SampleDefaultCompute",
"type": "Hub"
}
}
在发送请求后,将返回以下响应:
标头:
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
正文:
{
"name": "Hubtest",
"properties":
{
"defaultCompute": "SampleDefaultCompute",
"type": "Hub",
"hubId": "c4753e2a-4297-49ab-8269-ca4378ae4e37",
"provisioningState": "Succeeded"
}
}
删除
删除特定中心。
请求
可以按如下方式构造“删除集线器”请求(建议使用 HTTPS):
HTTP 谓词 | 请求 URI | HTTP 版本 |
---|---|---|
DELETE | https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/hubs/{HubName}?api-version={api-version} | HTTP/1.1 |
URI 参数
URI 参数 | 必需 | 说明 |
---|---|---|
订阅 ID | 是 | Azure 订阅 ID |
ResourceGroupName | 是 | 托管 Azure 数据工厂的资源组的唯一名称。 |
DataFactoryName | 是 | 你想要在其中删除集线器的数据工厂的名称。 |
HubName | 是 | 要删除的集线器的名称。 |
API 版本 | 是 | C# SDK/PowerShell 的 API 版本 |
请求标头
下表介绍请求标头。
请求头 | 必需 | 说明 |
---|---|---|
x-ms-client-request-id | 是 | 此请求的操作 ID。 |
请求正文
无。
响应
响应包括 HTTP 状态代码、一组响应标头和响应正文。
状态代码
200(正常)- 如果请求成功完成。
400(错误的请求)- 如果请求正文未通过验证。
404(找不到)- 如果订阅或资源组不存在。
412(不满足前提条件)- 如果不满足 If-Match 标头指定的条件。
501(未实现)- 如果验证未实现
响应标头
此操作的响应包括以下标头。 该响应还可能包括其他标准 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 |
日期 | 服务生成的 UTC 日期/时间值指示启动响应的时间。 |
响应正文
无。
示例请求和响应
示例 URI:
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
该请求与以下标头一起发送。
x-ms-client-request-id : 00000000-1111-1111-1111-000000000000
在发送请求后,将返回以下响应。
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
获取
获取有关现有中心的信息。
请求
Get Hub 请求可以按如下方式构造(建议使用 HTTPS):
HTTP 谓词 | 请求 URI | HTTP 版本 |
---|---|---|
GET | https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/hubs/{HubName}?api-version={api-version} | HTTP/1.1 |
URI 参数
URI 参数 | 必需 | 说明 |
---|---|---|
订阅 ID | 是 | Azure 订阅 ID。 |
ResourceGroupName | 是 | 托管 Azure 数据工厂的资源组的唯一名称。 |
DataFactoryName | 是 | 你要在其中获取集线器的数据工厂的名称。 |
HubName | 是 | 你要获取的集线器的名称。 |
API 版本 | 是 | 指定用于发出此请求的协议的版本。 |
请求标头
下表介绍请求标头。
请求头 | 必需 | 说明 |
---|---|---|
x-ms-client-request-id | 是 | 此请求的操作 ID。 |
请求正文
无。
响应
响应包括 HTTP 状态代码、一组响应标头和响应正文。
状态代码
200(正常)- 如果请求已成功完成。
400(错误的请求)- 如果请求正文未通过验证。
404(找不到)- 如果指定的订阅或资源组不存在。
412(不满足前提条件)- 如果不满足 If-Match 标头指定的条件。
501(未实现)- 如果验证未实现
响应标头
此操作的响应包括以下标头。 该响应还可能包括其他标准 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 |
日期 | 服务生成的 UTC 日期/时间值指示启动响应的时间。 |
响应正文
响应正文取决于你的集线器类型。
{
"name": <name>,
"properties": {
"defaultCompute": <computemethod>,
"type": <hubtype>,
"hubId": <hubID>,
"provisioningState": <provisioningstate>
}
}
下表介绍响应正文的元素。
元素名称 | 说明 |
---|---|
name | 集线器的名称。 |
Computemethod | 此集线器的计算方法。 |
type | 集线器的类型。 |
hubID | 为此集线器自动生成的 ID。 |
ProvisioningState | 指定集线器的当前设置状态。 在成功创建集线器后,此元素的值为Succeeded。 |
示例请求和响应
示例 URI:
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
该请求与以下标头一起发送。
x-ms-client-request-id : 00000000-1111-1111-1111-000000000000
在发送请求后,将返回以下响应。
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"
}
}
列出
列出有关数据工厂中所有中心的信息。
请求
可以按如下方式构造“列出集线器”请求(建议使用 HTTPS):
HTTP 谓词 | 请求 URI | HTTP 版本 |
---|---|---|
GET | https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/hubs?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 |
日期 | 服务生成的 UTC 日期/时间值指示启动响应的时间。 |
响应正文
{
"value": [
{
"name": <name1>,
"properties": {
"type": <hubtype>,
"hubId": <hubID>,
"provisioningState": <provisioningstate>
}
},
{
"name": <name2>,
"properties": {
"defaultCompute": <computemethod>,
"type": <hubtype>,
"hubId": <hubID>,
"provisioningState": <provisioningstate>
}
}
]
}
下表介绍响应正文的元素。
元素名称 | 说明 |
---|---|
name | 集线器的名称。 |
Computemethod | 此集线器的计算方法。 |
type | 集线器的类型 |
hubID | 为此集线器自动生成的 ID |
ProvisioningState | 指定集线器的当前设置状态。 成功创建集线器时,此元素的值为 Succeeded |
示例请求和响应
示例 URI:
GET: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/adf/providers/Microsoft.DataFactory/datafactories/test/hubs?api-version=2015-10-01
该请求与以下标头一起发送。
x-ms-client-request-id : 00000000-1111-1111-1111-000000000000
在发送请求后,将返回以下响应。
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"
}
}
]
}