Compartilhar via

Gateway versão 1 (V1)

  • Artigo

Observação

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

Criar

Cria um novo gateway.

Solicitação

A solicitação Criar ou Atualizar Gateway 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}/gateways/{GatewayName}?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 A fábrica de dados em que você deseja criar o gateway.
GatewayName Sim Nome do gateway 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 Obrigatório Descrição
x-ms-client-request-id Sim A ID da operação para essa solicitação.

Corpo da solicitação

O formato do corpo da solicitação é o seguinte.

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

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

Nome do elemento Necessário Descrição
name Sim Nome do gateway.
descrição Não Descrição do gateway.

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.

  • 202 (Aceito) – quando a solicitação é aceita.

  • 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

Corpo da resposta

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

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

Nome do elemento Descrição
name Nome do gateway.
local Local do gateway.
chave Chave do gateway usado para registro.
descrição Descrição do gateway.
hostServiceUri URI do computador host do gateway
dataFactoryName Nome da fábrica de dados à qual pertence o gateway.
status Status do gateway. Os valores podem ser Online, Offline ou NeedRegistration.
versionStatus Status da versão do gateway. Os valores podem ser UpToDate, Expiring, Expired, NewVersionAvailable e None.
provisioningState Especifica o estado atual de provisionamento do serviço vinculado. Quando um serviço vinculado é criado com êxito, o valor do elemento é Bem-sucedido
version Versão do gateway
createTime A hora em que o gateway foi criado.
registerTime A hora em que o gateway foi registrado.
expiryTime A hora em que o gateway expira.
lastConnectTime A hora em que o gateway foi conectado pela última vez.

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

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

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

E com o corpo a seguir.

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

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: 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

A resposta inclui o corpo XML a seguir.

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

Excluir

Exclui o gateway específico.

Solicitação

A solicitação Excluir Gateway 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}/gateways/{GatewayName}?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 A fábrica de dados em que você deseja criar o gateway.
GatewayName Sim Nome do gateway 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

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.

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

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

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

  
x-ms-client-request-id: 00000000-0000-0000-0000-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: 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

Obter

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

Solicitação

A solicitação Obter Gateway 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}/gateways/{GatewayName}?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 A fábrica de dados em que você deseja criar o gateway.
GatewayName Sim Nome do gateway 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

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, o grupo de recursos ou o gateway 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

Corpo da resposta

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

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

Nome do elemento Descrição
name Nome do gateway.
local Local do gateway.
chave Chave do gateway usado para registro. Ele sempre será nulo na operação de obtenção, pois a chave não pode ser recuperada.
descrição Descrição do gateway.
hostServiceUri URI para acessar o computador host do gateway.
dataFactoryName Nome da fábrica de dados à qual pertence o gateway.
status Status do gateway, que pode ser Online, Offline ou NeedRegistration.
versionStatus Status da versão do gateway, que pode ser UpToDate, Expiring, Expired, NewVersionAvailable e None.
provisioningState Especifica o estado atual de provisionamento do serviço vinculado. Quando um serviço vinculado é criado com êxito, o valor do elemento é Bem-sucedido
version Versão do gateway
createTime A hora em que o gateway foi criado.
registerTime A hora em que o gateway foi registrado.
expiryTime A hora em que o gateway expira.
lastConnectTime A hora em que o gateway foi conectado pela última vez.

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

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

x-ms-client-request-id: 00000000-0000-0000-0000-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: 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

A resposta inclui o corpo XML a seguir.

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

Lista

Lista informações de todos os gateways no data factory.

Solicitação

A solicitação Listar Gateways 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}/gateways?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 A fábrica de dados em que você deseja criar o gateway.
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

Corpo da resposta

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

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

Nome do elemento Descrição
name Nome do gateway.
local Local do gateway.
chave Chave do gateway usado para registro.
descrição Descrição do gateway.
hostServiceUri URI para acessar o computador host do gateway
dataFactoryName Nome da fábrica de dados à qual pertence o gateway.
status Status do gateway, que pode ser Online, Offline ou NeedRegistration
versionStatus Status da versão do gateway, que pode ser UpToDate, Expiring, Expired, NewVersionAvailable e None.
provisioningState Especifica o estado atual de provisionamento do serviço vinculado. Quando um serviço vinculado é criado com êxito, o valor do elemento é Bem-sucedido
version Versão do gateway
createTime A hora em que o gateway foi criado.
registerTime A hora em que o gateway foi registrado.
expiryTime A hora em que o gateway expira.
lastConnectTime A hora em que o gateway foi conectado pela última vez.

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

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

x-ms-client-request-id: 00000000-0000-0000-0000-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: 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

A resposta inclui o corpo XML a seguir.

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

Reneriza uma nova chave para um gateway existente que substitui a chave antiga.

Solicitação

A solicitação Regenerar Chave do Gateway pode ser construída da seguinte maneira (recomendado HTTPS):

Verbo HTTP URI da solicitação Versão 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 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 A fábrica de dados em que você deseja criar o gateway.
GatewayName Sim Nome do gateway 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

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

Corpo da resposta

  
{  
    "key": <key>  
}

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

Nome do elemento Descrição
chave Chave do gateway usado para registro

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

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

  
x-ms-client-request-id: 00000000-0000-0000-0000-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: 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

A resposta inclui o corpo XML a seguir.

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

Atualizar

Atualizações o conteúdo de um gateway existente.

Solicitação

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

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

Parâmetro URI Necessário Descrição
SubscriptionID Sim Sua ID da assinatura do Azure.
ResourceGroupName Sim O nome exclusivo do grupo de recursos que hospeda o serviço de Fábrica de Dados do Azure.
DataFactoryName Sim A fábrica de dados em que você deseja criar o gateway.
GatewayName Sim Nome do gateway 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 Obrigatório Descrição
x-ms-client-request-id Sim A ID da operação para essa solicitação.

Corpo da solicitação

Formato do corpo da solicitação:

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

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

Nome do elemento Necessário Descrição
descrição Não Descrição do gateway.

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

Corpo da resposta

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

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

Nome do elemento Descrição
name Nome do gateway.
local Local do gateway.
chave Chave do gateway usado para registro.
descrição Descrição do gateway.
hostServiceUri URI para acessar o computador host do gateway.
dataFactoryName Nome da fábrica de dados à qual pertence o gateway.
status Status do gateway, que pode ser Online, Offline ou NeedRegistration.
versionStatus Status da versão do gateway, que pode ser UpToDate, Expiring, Expired, NewVersionAvailable e None.
provisioningState Especifica o estado atual de provisionamento do serviço vinculado. Quando um serviço vinculado é criado com êxito, o valor do elemento é Bem-sucedido
version Versão do gateway
createTime A hora em que o gateway foi criado.
registerTime A hora em que o gateway foi registrado.
expiryTime A hora em que o gateway expira.
lastConnectTime A hora em que o gateway foi conectado pela última vez.

Exemplo de solicitação e resposta

URI de exemplo:

  
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

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

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

E com o seguinte corpo:

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

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: 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

A resposta inclui o corpo XML a seguir.

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