Hub version 1 (V1)

  • Article

Note

This reference documentation applies to Azure Data Factory version 1 (V1).

Create or Update

Creates a new hub, or updates the content of an existing hub.

Request

The Create or Update Hub request may be constructed as follows (HTTPS is recommended):

HTTP Verb Request URI HTTP Version
PUT https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/hubs/{HubName}?api-version={api-version} HTTP/1.1

URI Parameters

URI Parameter Required Description
SubscriptionID Yes Your Azure subscription ID.
ResourceGroupName Yes A unique name for the resource group that hosts your Azure data factory Service.
DataFactoryName Yes Name for the data factory that you want to create your hub in.
HubName Yes Name of hub you want to create.
Api-Version Yes Specifies the version of the protocol used to make this request.

Request Headers

The following table describes the request headers.

Request Header Required Description
x-ms-client-request-id Yes The operation ID for this request.

Request Body

Request body depends on your hub type. The format of the request body is as follows:

  
{  
    "name": <hubname>,  
    "properties": {  
        "defaultCompute": <computemethod>,  
        "type": <hubtype>  
    }  
}

The following table describes the elements of the request body.

Element Name Required Description
name Yes Name of the hub.
properties Yes Property of the hub.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Codes

  • 200 (OK) – Request completed successfully.

  • 202 (Accepted) - Request was accepted.

  • 400 (Bad Request) - Request body fails validation.

  • 404 (NotFound) - Subscription or resource group or data factory does not exist.

  • 412 (Precondition Failed) - Condition specified by If-Match header failed.

  • 501 (Not Implemented) - Validate is not implemented

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header Description
x-ms-request-id A unique identifier for the current operation, service generated.
x-ms-ratelimit-remaining-subscription-writes The remaining limit for current subscription.
x-ms-correlation-request-id Specifies the tracing correlation Id for the request; the resource provider must log this so that end-to-end requests can be correlated across Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Date A UTC date/time value generated by the service that indicates the time at which the response was initiated.
Location URI of the object you want to create or get.

Response Body

  
{  
    "name": <name>,  
    "properties":   
    {  
        "defaultCompute": <computemethod>,  
        "type": <hubtype>,  
        "hubId": <hubID>,  
        "provisioningState": <provisioningstate>  
    }  
}

The following table describes the elements of the response body.

Element Name Description
name Name of the hub
ComputeMethod Compute method of this hub.
type Type of the hub
hubID Auto-generated ID for this hub.
ProvisioningState Specifies the current provisioning state of the hub. When a hub is successfully created, the value of the element is Succeeded

Sample Request and Response

Example 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

The request is sent with the following headers:

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

and the following body:

  
{  
    "name": "Hubtest",  
    "properties":   
    {  
        "defaultCompute": "SampleDefaultCompute",  
        "type": "Hub"  
    }  
}

After the request has been sent, the following response is returned:

Header:

  
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

Body:

  
{  
    "name": "Hubtest",  
    "properties":   
    {  
        "defaultCompute": "SampleDefaultCompute",  
        "type": "Hub",  
        "hubId": "c4753e2a-4297-49ab-8269-ca4378ae4e37",  
        "provisioningState": "Succeeded"  
    }  
}

Delete

Deletes the specific hub.

Request

The Delete Hub request may be constructed as follows ( HTTPS is recommended):

HTTP Verb Request URI HTTP Version
DELETE https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/hubs/{HubName}?api-version={api-version} HTTP/1.1

URI Parameters

URI Parameter Required Description
SubscriptionID Yes Your Azure subscription ID
ResourceGroupName Yes A unique name for the resource group that hosts your Azure data factory.
DataFactoryName Yes Name for the data factory that you want to delete your hub in.
HubName Yes Name of hub you want to delete.
Api-Version Yes API version of your C# SDK/PowerShell

Request Headers

The following table describes the request headers.

Request Header Required Description
x-ms-client-request-id Yes The operation id for this request.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

  • 200 (OK) if request completed successfully.

  • 400 (Bad Request) if request body fails validation.

  • 404 (NotFound) if subscription or resource group does not exist.

  • 412 (Precondition Failed) if failed condition specified by If-Match header.

  • 501 (Not Implemented) if validate is not implemented

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header Description
x-ms-request-id A unique identifier for the current operation, service generated.
x-ms-ratelimit-remaining-subscription-writes The remaining limit for current subscription.
x-ms-correlation-request-id Specifies the tracing correlation Id for the request; the resource provider must log this so that end-to-end requests can be correlated across Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Date A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Response Body

None.

Sample Request and Response

Example 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

The request is sent with the following headers.

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

After the request has been sent, the following response is returned.

  
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

Gets information about an existing hub.

Request

The Get Hub request may be constructed as follows (HTTPS is recommended):

HTTP Verb Request URI HTTP Version
GET https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/hubs/{HubName}?api-version={api-version} HTTP/1.1

URI Parameters

URI Parameter Required Description
SubscriptionID Yes Your Azure subscription ID.
ResourceGroupName Yes The unique name for the resource group that hosts your Azure data factory.
DataFactoryName Yes Name for the data factory that you want to get your hub.
HubName Yes Name of hub you want to get.
Api-Version Yes Specifies the version of the protocol used to make this request.

Request Headers

The following table describes the request headers.

Request Header Required Description
x-ms-client-request-id Yes the operation id for this request.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

  • 200 (OK) - if the request was completed successfully.

  • 400 (Bad Request) - if the request body fails validation.

  • 404 (NotFound) - if the specified subscription or resource group does not exist.

  • 412 (Precondition Failed) - if the condition specified by the If-Match header failed.

  • 501 (Not Implemented) - if validate is not implemented

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header Description
x-ms-request-id A unique identifier for the current operation, service generated.
x-ms-ratelimit-remaining-subscription-writes The remaining limit for current subscription.
x-ms-correlation-request-id Specifies the tracing correlation Id for the request; the resource provider must log this so that end-to-end requests can be correlated across Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Date A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Response Body

Response body depends on you hub type.

  
{  
    "name": <name>,  
    "properties": {  
        "defaultCompute": <computemethod>,  
        "type": <hubtype>,  
        "hubId": <hubID>,  
        "provisioningState": <provisioningstate>  
    }  
}

The following table describes the elements of the response body.

Element Name Description
name Name of the hub.
Computemethod Compute method of this hub.
type Type of the hub.
hubID Auto-generated ID for this hub.
ProvisioningState Specifies the current provisioning state of the hub. When a hub is successfully created, the value of the element is Succeeded.

Sample Request and Response

Example 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

The request is sent with the following headers.

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

After the request has been sent, the following response is returned.

  
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

Lists information about all hubs in the data factory.

Request

The List Hubs request may be constructed as follows (HTTPS is recommended):

HTTP Verb Request URI HTTP Version
GET https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/hubs?api-version={api-version} HTTP/1.1

URI Parameters

URI Parameter Required Description
SubscriptionID Yes Your Azure subscription ID.
ResourceGroupName Yes A unique name for the resource group that hosts your Azure data factory.
DataFactoryName Yes Name for the data factory that you want to find your hub.
Api-Version Yes Specifies the version of the protocol used to make this request.

Request Headers

The following table describes the request headers.

Request Header Required Description
x-ms-client-request-id Yes The operation id for this request.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

  • 200 (OK) - if the request completed successfully.

  • 400 (Bad Request) - if the request body fails validation.

  • 404 (NotFound) - if the subscription or resource group does not exist.

  • 412 (Precondition Failed) - if the condition specified by If-Match header failed.

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header Description
x-ms-request-id A unique identifier for the current operation, service generated.
x-ms-ratelimit-remaining-subscription-writes The remaining limit for current subscription.
x-ms-correlation-request-id Specifies the tracing correlation Id for the request. The resource provider must log this so that end-to-end requests can be correlated across Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Date A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Response Body

  
{  
    "value": [  
    {  
        "name": <name1>,  
        "properties": {  
              "type": <hubtype>,  
              "hubId": <hubID>,  
              "provisioningState": <provisioningstate>  
        }  
    },  
    {  
        "name": <name2>,  
        "properties": {  
            "defaultCompute": <computemethod>,  
            "type": <hubtype>,  
            "hubId": <hubID>,  
           "provisioningState": <provisioningstate>  
        }  
    }  
    ]  
}

The following table describes the elements of the response body.

Element Name Description
name Name of the hub.
Computemethod Compute method of this hub.
type Type of the hub
hubID Auto-generated ID for this hub
ProvisioningState Specifies the current provisioning state of the hub. When a hub is successfully created, the value of the element is Succeeded

Sample Request and Response

Example 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

The request is sent with the following headers.

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

After the request has been sent, the following response is returned.

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