Compartilhar via

Hub versão 1 (V1)

  • Artigo

Observação

Esta documentação de referência se aplica a Azure Data Factory versão 1 (V1).

Criar ou Atualizar

Cria um novo hub ou atualiza o conteúdo de um hub existente.

Solicitação

A solicitação Criar ou Atualizar Hub pode ser construída da seguinte maneira (recomendado HTTPS):

Verbo HTTP URI da solicitação Versão 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 URI

Parâmetro URI Necessário Descrição
SubscriptionID Sim Sua ID da assinatura do Azure.
ResourceGroupName Sim Um nome exclusivo para o grupo de recursos que hospeda seu serviço de fábrica de dados do Azure.
DataFactoryName Sim Nome da fábrica de dados em que você deseja criar seu hub.
HubName Sim Nome do hub que deseja criar.
Versão da API Sim Especifica a versão do protocolo usado para fazer essa solicitação.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos da solicitação.

Cabeçalho da solicitação Necessário Descrição
x-ms-client-request-id Sim A ID da operação para essa solicitação.

Corpo da solicitação

O corpo da solicitação depende do tipo de hub. Formato do corpo da solicitação:

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

A tabela a seguir descreve os elementos do corpo da solicitação.

Nome do elemento Necessário Descrição
name Sim Nome do hub.
properties Sim Propriedade do hub.

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Códigos de status

  • 200 (OK) – Solicitação concluída com êxito.

  • 202 (Aceito) – Solicitação aceita.

  • 400 (Solicitação Incorreta) – O corpo da solicitação falha na validação.

  • 404 (Não Encontrado) – A assinatura ou a fábrica de dados ou o grupo de recursos não existe.

  • 412 (Falha na Precondição) – A condição especificada pelo cabeçalho If-Match falhou.

  • 501 (Não Implementado) – Validar não implementado

Cabeçalhos de resposta

A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de resposta Descrição
x-ms-request-id Um identificador exclusivo para a operação atual, serviço gerado.
x-ms-ratelimit-remaining-subscription-writes O limite restante da assinatura atual.
x-ms-correlation-request-id Especifica a ID de correlação de rastreamento para a solicitação; o provedor de recursos deve registrar isso para que as solicitações de ponta a ponta possam ser correlacionadas no Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Data Um valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada.
Location URI do objeto que você deseja criar ou obter.

Corpo da resposta

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

A tabela a seguir descreve os elementos do corpo da resposta.

Nome do elemento Descrição
name Nome do hub
ComputeMethod Método de computação desse hub.
type Tipo do hub
hubID ID gerada automaticamente para esse hub.
ProvisioningState Especifica o estado atual de provisionamento do hub. Quando um hub é criado com êxito, o valor do elemento é Bem-sucedido

Exemplo de solicitação e resposta

URI de exemplo:

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

A solicitação é enviada com os seguintes cabeçalhos:

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

e o seguinte corpo:

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

Depois que a solicitação tiver sido enviada, a resposta a seguir será retornada:

Cabeçalho:

  
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

Corpo:

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

Excluir

Exclui o hub específico.

Solicitação

A solicitação Excluir Hub pode ser construída da seguinte maneira (recomendado HTTPS):

Verbo HTTP URI da solicitação Versão HTTP
Delete (excluir) 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 URI

Parâmetro URI Necessário Descrição
SubscriptionID Sim ID da assinatura do Azure
ResourceGroupName Sim Um nome exclusivo para o grupo de recursos que hospeda sua fábrica de dados do Azure.
DataFactoryName Sim Nome da fábrica de dados da qual deseja excluir o hub.
HubName Sim Nome do hub que deseja excluir.
Versão da API Sim Versão da API do seu C# SDK/PowerShell

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos da solicitação.

Cabeçalho da solicitação Necessário Descrição
x-ms-client-request-id Sim A ID da operação para essa solicitação.

Corpo da solicitação

Nenhum.

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Código de status

  • 200 (OK) – quando a solicitação é concluída com êxito.

  • 400 (Solicitação Incorreta) – quando o corpo da solicitação falha na validação.

  • 404 (Não Encontrado) – quando a assinatura ou grupo de recursos não existe.

  • 412 (Falha na Pré-condição) – quando a condição especificada pelo cabeçalho If-Match falha.

  • 501 (Não Implementado) – quando a validação não está implementada

Cabeçalhos de resposta

A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de resposta Descrição
x-ms-request-id Um identificador exclusivo para a operação atual, serviço gerado.
x-ms-ratelimit-remaining-subscription-writes O limite restante da assinatura atual.
x-ms-correlation-request-id Especifica a ID de correlação de rastreamento para a solicitação; o provedor de recursos deve registrar isso para que as solicitações de ponta a ponta possam ser correlacionadas no Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Data Um valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada.

Corpo da resposta

Nenhum.

Exemplo de solicitação e resposta

URI de exemplo:

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

A solicitação é enviada com os seguintes cabeçalhos.

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

Depois que a solicitação tiver sido enviada, a resposta a seguir será retornada.

  
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

Obter

Obtém informações sobre um hub existente.

Solicitação

A solicitação Obter Hub pode ser construída da seguinte maneira (recomendado HTTPS):

Verbo HTTP URI da solicitação Versão de 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 URI

Parâmetro URI Necessário Descrição
SubscriptionID Sim Sua ID da assinatura do Azure.
ResourceGroupName Sim O nome exclusivo para o grupo de recursos que hospeda sua Fábrica de Dados do Azure.
DataFactoryName Sim Nome da fábrica de dados em que você deseja obter o hub.
HubName Sim Nome do hub que deseja obter.
Versão da API Sim Especifica a versão do protocolo usado para fazer essa solicitação.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos da solicitação.

Cabeçalho da solicitação Necessário Descrição
x-ms-client-request-id Sim A ID da operação para essa solicitação.

Corpo da solicitação

Nenhum.

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Código de status

  • 200 (OK) – quando a solicitação é concluída com êxito.

  • 400 (Solicitação Incorreta) – quando o corpo da solicitação falha na validação.

  • 404 (Não Encontrado) – quando a assinatura especificada ou grupo de recursos especificado não existe.

  • 412 (Falha na Pré-condição) – quando a condição especificada pelo cabeçalho If-Match falha.

  • 501 (Não Implementado) – quando a validação não está implementada

Cabeçalhos de resposta

A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de resposta Descrição
x-ms-request-id Um identificador exclusivo para a operação atual, serviço gerado.
x-ms-ratelimit-remaining-subscription-writes O limite restante da assinatura atual.
x-ms-correlation-request-id Especifica a ID de correlação de rastreamento para a solicitação; o provedor de recursos deve registrar isso para que as solicitações de ponta a ponta possam ser correlacionadas no Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Data Um valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada.

Corpo da resposta

O corpo da resposta depende do tipo do hub.

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

A tabela a seguir descreve os elementos do corpo da resposta.

Nome do elemento Descrição
name Nome do hub.
Computemethod Método de computação desse hub.
type Tipo do hub.
hubID ID gerada automaticamente para esse hub.
ProvisioningState Especifica o estado atual de provisionamento do hub. Quando um hub é criado com êxito, o valor do elemento é Bem-sucedido.

Exemplo de solicitação e resposta

URI de exemplo:

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

A solicitação é enviada com os seguintes cabeçalhos.

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

Depois que a solicitação tiver sido enviada, a resposta a seguir será retornada.

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

Lista

Lista informações sobre todos os hubs no data factory.

Solicitação

A solicitação Listar Hubs pode ser construída da seguinte maneira (recomendado HTTPS):

Verbo HTTP URI da solicitação Versão 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 URI

Parâmetro URI Necessário Descrição
SubscriptionID Sim Sua ID da assinatura do Azure.
ResourceGroupName Sim Um nome exclusivo para o grupo de recursos que hospeda sua fábrica de dados do Azure.
DataFactoryName Sim Nome da fábrica de dados em que você deseja localizar seu hub.
Versão da API Sim Especifica a versão do protocolo usado para fazer essa solicitação.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos da solicitação.

Cabeçalho da solicitação Necessário Descrição
x-ms-client-request-id Sim A ID da operação para essa solicitação.

Corpo da solicitação

Nenhum.

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Código de status

  • 200 (OK) - se a solicitação foi concluída com êxito.

  • 400 (Solicitação Incorreta) – quando o corpo da solicitação falha na validação.

  • 404 (Não Encontrado) – quando a assinatura ou grupo de recursos não existe.

  • 412 (Falha na Pré-condição) – quando a condição especificada pelo cabeçalho If-Match falha.

Cabeçalhos de resposta

A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de resposta Descrição
x-ms-request-id Um identificador exclusivo para a operação atual, serviço gerado.
x-ms-ratelimit-remaining-subscription-writes O limite restante da assinatura atual.
x-ms-correlation-request-id Especifica a ID de correlação de rastreamento para a solicitação. O provedor de recursos deve registrar isso para que as solicitações de ponta a ponta possam ser correlacionadas no Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Data Um valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada.

Corpo da resposta

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

A tabela a seguir descreve os elementos do corpo da resposta.

Nome do elemento Descrição
name Nome do hub.
Computemethod Método de computação desse hub.
type Tipo do hub
hubID ID gerada automaticamente para esse hub
ProvisioningState Especifica o estado atual de provisionamento do hub. Quando um hub é criado com êxito, o valor do elemento é Bem-sucedido

Exemplo de solicitação e resposta

URI de exemplo:

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

A solicitação é enviada com os seguintes cabeçalhos.

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

Depois que a solicitação tiver sido enviada, a resposta a seguir será retornada.

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