Gateway version 1 (V1)

Artikel
07/19/2023

Anteckning

Den här referensdokumentationen gäller för Azure Data Factory version 1 (V1).

Skapa

Skapar en ny gateway.

Förfrågan

Begäran om att skapa eller uppdatera gatewayen kan konstrueras på följande sätt (HTTPS rekommenderas):

HTTP-verb	URI för förfrågan	HTTP-version
PUT	https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/gateways/{GatewayName}?api-version={api-version}	HTTP/1.1

URI-parametrar

URI-parameter	Obligatoriskt	Beskrivning
SubscriptionID	Yes	ditt prenumerations-ID för Azure
ResourceGroupName	Yes	Ett unikt namn för resursgruppen som är värd för din Azure-datafabrik.
DataFactoryName	Yes	Namn på den datafabrik som du vill skapa din gateway i.
GatewayName	Yes	Namnet på den gateway som du vill skapa
Api-Version	Yes	Anger vilken version av protokollet som används för att göra den här begäran.

Rubriker för begäran

I följande tabell beskrivs begärandehuvudena.

Begärandehuvud	Krävs	Beskrivning
x-ms-client-request-id	Yes	Åtgärds-ID för den här begäran.

Begärandetext

Formatet för begärandetexten är följande.

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

I följande tabell beskrivs elementen i begärandetexten.

Elementnamn	Obligatoriskt	Beskrivning
name	Yes	Namnet på gatewayen.
beskrivning	No	Beskrivning av gatewayen.

Svarsåtgärder

Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och en svarstext.

Statuskod

200 (OK) – om begäran har slutförts.
202 (godkänd) – om begäran godkändes.
400 (felaktig begäran) – om begärandetexten misslyckas med valideringen.
404 (NotFound) – om prenumerationen eller resursgruppen inte finns.
412 (Förhandsvillkoret misslyckades) – om villkoret som anges av If-Match sidhuvud misslyckades.

Svarsrubriker

Svaret för den här åtgärden innehåller följande rubriker. Svaret kan också innehålla ytterligare HTTP-standardhuvuden. Alla standardhuvuden överensstämmer med http/1.1-protokollspecifikationen.

Svarsrubrik	Beskrivning
x-ms-request-id	En unik identifierare för den aktuella åtgärden som genereras av tjänsten.
x-ms-ratelimit-remaining-subscription-writes	Den återstående gränsen för den aktuella prenumerationen.
x-ms-correlation-request-id	Anger spårningens korrelations-ID för begäran. Resursprovidern måste logga detta så att begäranden från slutpunkt till slutpunkt kan korreleras i Hela Azure.
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

Svarstext

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

I följande tabell beskrivs elementen i svarstexten.

Elementnamn	Beskrivning
name	Namnet på gatewayen.
location	Plats för gatewayen.
key	Nyckeln för den gateway som används för registrering.
beskrivning	Beskrivning av gatewayen.
hostServiceUri	Uri för gatewayens värddator
dataFactoryName	Namnet på den datafabrik som gatewayen tillhör.
status	Status för gatewayen. Värdena kan vara Online, Offline eller NeedRegistration.
versionStatus	Status för gatewayversionen. Värdena kan vara UpToDate, Expiring, Expired, NewVersionAvailable och None.
provisioningState	Anger det aktuella etableringstillståndet för den länkade tjänsten. När en länkad tjänst har skapats är värdet för elementet Lyckades.
version	Version av gatewayen
createTime	Tidpunkten då gatewayen skapades.
registerTime	Tidpunkt då gatewayen registrerades.
expiryTime	Tiden då gatewayen upphör att gälla.
lastConnectTime	Den tidpunkt då gatewayen var anslutning för sista gången.

Exempel på begäran och svar

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

Begäran skickas med följande rubriker.

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

Och med följande brödtext.

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

När begäran har skickats returneras följande svar.

  
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

Svaret innehåller följande XML-brödtext.

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

Ta bort

Tar bort den specifika gatewayen.

Förfrågan

Begäran om att ta bort gatewayen kan konstrueras på följande sätt (HTTPS rekommenderas):

HTTP-verb	URI för förfrågan	HTTP-version
DELETE	https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/gateways/{GatewayName}?api-version={api-version}	HTTP/1.1

URI-parametrar

URI-parameter	Obligatoriskt	Beskrivning
SubscriptionID	Yes	ditt prenumerations-ID för Azure
ResourceGroupName	Yes	Ett unikt namn för resursgruppen som är värd för din Azure-datafabrik.
DataFactoryName	Yes	Namn på den datafabrik som du vill skapa din gateway i.
GatewayName	Yes	Namnet på den gateway som du vill skapa.
Api-Version	Yes	Anger vilken version av protokollet som används för att göra den här begäran.

Rubriker för begäran

I följande tabell beskrivs begäranderubrikerna.

Begärandehuvud	Obligatoriskt	Beskrivning
x-ms-client-request-id	Yes	Åtgärds-ID för den här begäran.

Begärandetext

Inga.

Svarsåtgärder

Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och en svarstext.

Statuskod

200 (OK) – om begäran slutfördes.
400 (felaktig begäran) – om begärandetexten misslyckas med valideringen.
404 (NotFound) – om prenumerationen eller resursgruppen inte finns.
412 (Villkoret misslyckades) – om villkoret som anges av If-Match sidhuvud misslyckades.

Svarsrubriker

Svaret för den här åtgärden innehåller följande rubriker. Svaret kan också innehålla ytterligare HTTP-standardhuvuden. Alla standardhuvuden överensstämmer med HTTP/1.1-protokollspecifikationen.

Svarshuvud	Beskrivning
x-ms-request-id	En unik identifierare för den aktuella åtgärden, genererad av tjänsten.
x-ms-ratelimit-remaining-subscription-writes	Den återstående gränsen för den aktuella prenumerationen.
x-ms-correlation-request-id	Anger spårningskorrelations-ID för begäran. Resursprovidern måste logga detta så att begäranden från slutpunkt till slutpunkt kan korreleras i Azure.
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

Svarstext

Inga.

Exempel på begäran och svar

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

Begäran skickas med följande rubriker.

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

När begäran har skickats returneras följande svar.

  
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

Hämta

Hämtar information om en befintlig gateway.

Förfrågan

Get Gateway-begäran kan konstrueras på följande sätt (HTTPS rekommenderas):

HTTP-verb	URI för förfrågan	HTTP-version
GET	https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/gateways/{GatewayName}?api-version={api-version}	HTTP/1.1

URI-parametrar

URI-parameter	Obligatoriskt	Beskrivning
SubscriptionID	Yes	ditt prenumerations-ID för Azure
ResourceGroupName	Yes	Ett unikt namn för resursgruppen som är värd för din Azure-datafabrik.
DataFactoryName	Yes	Namn på den datafabrik som du vill skapa din gateway i.
GatewayName	Yes	Namnet på den gateway som du vill skapa.
Api-Version	Yes	Anger vilken version av protokollet som används för att göra den här begäran.

Rubriker för begäran

I följande tabell beskrivs begäranderubrikerna.

Begärandehuvud	Obligatoriskt	Beskrivning
x-ms-client-request-id	Yes	Åtgärds-ID för den här begäran.

Begärandetext

Inga.

Svarsåtgärder

Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och en svarstext.

Statuskod

200 (OK) – om begäran har slutförts.
400 (felaktig begäran) – om begärandetexten misslyckas med valideringen.
404 (NotFound) – om prenumerationen eller resursgruppen eller gatewayen inte finns.
412 (Villkoret misslyckades) – om villkoret som anges av If-Match sidhuvud misslyckades.

Svarsrubriker

Svarshuvud	Beskrivning
x-ms-request-id	En unik identifierare för den aktuella åtgärden, genererad av tjänsten.
x-ms-ratelimit-remaining-subscription-writes	Den återstående gränsen för den aktuella prenumerationen.
x-ms-correlation-request-id	Anger spårningskorrelations-ID för begäran. Resursprovidern måste logga detta så att begäranden från slutpunkt till slutpunkt kan korreleras i Azure.
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

Svarstext

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

I följande tabell beskrivs elementen i svarstexten.

Elementnamn	Beskrivning
name	Namnet på gatewayen.
location	Plats för gatewayen.
key	Nyckeln för den gateway som används för registrering. Det kommer alltid att vara null i get-åtgärden eftersom nyckeln inte kan hämtas.
beskrivning	Beskrivning av gatewayen.
hostServiceUri	Uri för att komma åt gatewayens värddator.
dataFactoryName	Namnet på den datafabrik som gatewayen tillhör.
status	Status för gatewayen, som kan vara Online, Offline eller NeedRegistration.
versionStatus	Status för gatewayversionen, som kan vara UpToDate, Expiring, Expired, NewVersionAvailable och None.
provisioningState	Anger det aktuella etableringstillståndet för den länkade tjänsten. När en länkad tjänst har skapats är värdet för elementet Lyckades.
version	Version av gatewayen.
createTime	Tidpunkten då gatewayen skapades.
registerTime	Tidpunkt då gatewayen registrerades.
expiryTime	Tiden då gatewayen upphör att gälla.
lastConnectTime	Den tidpunkt då gatewayen var anslutning för sista gången.

Exempel på begäran och svar

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

Begäran skickas med följande rubriker.

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

När begäran har skickats returneras följande svar.

  
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

Svaret innehåller följande XML-brödtext.

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

Visar information om alla gatewayer i datafabriken.

Förfrågan

Begäran om listgatewayer kan konstrueras på följande sätt (HTTPS rekommenderas):

HTTP-verb	URI för förfrågan	HTTP-version
GET	https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/gateways?api-version={api-version}	HTTP/1.1

URI-parametrar

URI-parameter	Obligatoriskt	Beskrivning
SubscriptionID	Yes	ditt prenumerations-ID för Azure
ResourceGroupName	Yes	Ett unikt namn för resursgruppen som är värd för din Azure-datafabrik.
DataFactoryName	Yes	Namn på den datafabrik som du vill skapa din gateway i.
Api-Version	Yes	Anger vilken version av protokollet som används för att göra den här begäran.

Rubriker för begäran

I följande tabell beskrivs begärandehuvudena.

Begärandehuvud	Obligatoriskt	Beskrivning
x-ms-client-request-id	Yes	Åtgärds-ID för den här begäran.

Begärandetext

Inga.

Svarsåtgärder

Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och en svarstext.

Statuskod

200 (OK) – om begäran har slutförts.
400 (felaktig begäran) – om begärandetexten misslyckas med valideringen.
404 (NotFound) – om prenumerationen eller resursgruppen inte finns.
412 (Förhandsvillkoret misslyckades) – om villkoret som anges av If-Match sidhuvud misslyckades.

Svarsrubriker

Svarsrubrik	Beskrivning
x-ms-request-id	En unik identifierare för den aktuella åtgärden som genereras av tjänsten.
x-ms-ratelimit-remaining-subscription-writes	Den återstående gränsen för den aktuella prenumerationen.
x-ms-correlation-request-id	Anger spårningens korrelations-ID för begäran. Resursprovidern måste logga detta så att begäranden från slutpunkt till slutpunkt kan korreleras i Hela Azure.
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

Svarstext

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

I följande tabell beskrivs elementen i svarstexten.

Elementnamn	Beskrivning
name	Namnet på gatewayen.
location	Plats för gatewayen.
key	Nyckeln för den gateway som används för registrering.
beskrivning	Beskrivning av gatewayen.
hostServiceUri	URI för åtkomst till gatewayens värddator
dataFactoryName	Namnet på den datafabrik som gatewayen tillhör.
status	Status för gatewayen, som kan vara Online, Offline eller NeedRegistration
versionStatus	Status för gatewayversionen, som kan vara UpToDate, Expiring, Expired, NewVersionAvailable och None.
provisioningState	Anger det aktuella etableringstillståndet för den länkade tjänsten. När en länkad tjänst har skapats är värdet för elementet Lyckades.
version	Version av gatewayen.
createTime	Tidpunkten då gatewayen skapades.
registerTime	Tidpunkten då gatewayen registrerades.
expiryTime	Tiden då gatewayen upphör att gälla.
lastConnectTime	Tidpunkten då gatewayen var anslutning för senaste gången.

Exempel på begäran och svar

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

Begäran skickas med följande rubriker.

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

När begäran har skickats returneras följande svar.

  
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

Svaret innehåller följande XML-brödtext.

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

Återskapa nyckel

Omförhandlar en ny nyckel för en befintlig gateway som ersätter den gamla nyckeln.

Förfrågan

Begäran om att återskapa gatewaynyckeln kan konstrueras på följande sätt (HTTPS rekommenderas):

HTTP-verb	URI för förfrågan	HTTP-version
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-parametrar

URI-parameter	Obligatoriskt	Beskrivning
SubscriptionID	Yes	ditt prenumerations-ID för Azure
ResourceGroupName	Yes	Ett unikt namn för resursgruppen som är värd för din Azure-datafabrik.
DataFactoryName	Yes	Namn på den datafabrik som du vill skapa din gateway i.
GatewayName	Yes	Namnet på den gateway som du vill skapa.
Api-Version	Yes	Anger vilken version av protokollet som används för att göra den här begäran.

Rubriker för begäran

I följande tabell beskrivs begärandehuvudena.

Begärandehuvud	Obligatoriskt	Beskrivning
x-ms-client-request-id	Yes	Åtgärds-ID för den här begäran.

Begärandetext

Inga.

Svarsåtgärder

Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och en svarstext.

Statuskod

200 (OK) – om begäran har slutförts.
400 (felaktig begäran) – om begärandetexten misslyckas med valideringen.
404 (NotFound) – om prenumerationen eller resursgruppen inte finns.
412 (Förhandsvillkoret misslyckades) – om villkoret som anges av If-Match sidhuvud misslyckades.

Svarsrubriker

Svarsrubrik	Beskrivning
x-ms-request-id	En unik identifierare för den aktuella åtgärden som genereras av tjänsten.
x-ms-ratelimit-remaining-subscription-writes	Den återstående gränsen för den aktuella prenumerationen.
x-ms-correlation-request-id	Anger spårningens korrelations-ID för begäran. Resursprovidern måste logga detta så att begäranden från slutpunkt till slutpunkt kan korreleras i Hela Azure.
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

Svarstext

  
{  
    "key": <key>  
}

I följande tabell beskrivs elementen i svarstexten.

Elementnamn	Description
key	Nyckeln för den gateway som används för registrering

Exempel på begäran och svar

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

Begäran skickas med följande rubriker.

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

När begäran har skickats returneras följande svar.

  
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

Svaret innehåller följande XML-brödtext.

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

Uppdatera

Uppdateringar innehållet i en befintlig gateway.

Förfrågan

Update Gateway-begäran kan konstrueras på följande sätt (HTTPS rekommenderas):

HTTP-verb	URI för förfrågan	HTTP-version
PATCH	https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/gateways/{GatewayName}?api-version={api-version}	HTTP/1.1

URI-parametrar

URI-parameter	Obligatoriskt	Beskrivning
SubscriptionID	Yes	ditt prenumerations-ID för Azure
ResourceGroupName	Yes	Det unika namnet på resursgruppen som är värd för din Azure-datafabrikstjänst.
DataFactoryName	Yes	Namn på den datafabrik som du vill skapa din gateway i.
GatewayName	Yes	Namnet på den gateway som du vill skapa.
Api-Version	Yes	Anger vilken version av protokollet som används för att göra den här begäran.

Rubriker för begäran

I följande tabell beskrivs begärandehuvudena.

Begärandehuvud	Krävs	Beskrivning
x-ms-client-request-id	Yes	Åtgärds-ID för den här begäran.

Begärandetext

Formatet för begärandetexten är följande:

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

I följande tabell beskrivs elementen i begärandetexten.

Elementnamn	Obligatoriskt	Beskrivning
beskrivning	No	Beskrivning av gatewayen.

Svarsåtgärder

Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och en svarstext.

Statuskod

200 (OK) – om begäran har slutförts.
400 (felaktig begäran) – om begärandetexten misslyckas med valideringen.
404 (NotFound) – om prenumerationen eller resursgruppen inte finns.
412 (Förhandsvillkoret misslyckades) – om villkoret som anges av If-Match sidhuvud misslyckades.

Svarsrubriker

Svarshuvud	Beskrivning
x-ms-request-id	En unik identifierare för den aktuella åtgärden, genererad av tjänsten.
x-ms-ratelimit-remaining-subscription-writes	Den återstående gränsen för den aktuella prenumerationen.
x-ms-correlation-request-id	Anger spårningskorrelations-ID för begäran. Resursprovidern måste logga detta så att begäranden från slutpunkt till slutpunkt kan korreleras i Azure.
x-ms-routing-request-id	Location+DateTime+correlation-request-ID

Svarstext

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

I följande tabell beskrivs elementen i svarstexten.

Elementnamn	Beskrivning
name	Namnet på gatewayen.
location	Plats för gatewayen.
key	Nyckeln för den gateway som används för registrering.
beskrivning	Beskrivning av gatewayen.
hostServiceUri	Uri för åtkomst till gatewayens värddator.
dataFactoryName	Namnet på den datafabrik som gatewayen tillhör.
status	Status för gatewayen, som kan vara Online, Offline eller NeedRegistration.
versionStatus	Status för gatewayversionen, som kan vara UpToDate, Expiring, Expired, NewVersionAvailable och None.
provisioningState	Anger det aktuella etableringstillståndet för den länkade tjänsten. När en länkad tjänst har skapats är värdet för elementet Lyckades.
version	Version av gatewayen.
createTime	Tidpunkten då gatewayen skapades.
registerTime	Tidpunkt då gatewayen registrerades.
expiryTime	Tiden då gatewayen upphör att gälla.
lastConnectTime	Den tidpunkt då gatewayen var anslutning för sista gången.

Exempel på begäran och svar

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

Begäran skickas med följande rubriker.

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

Och med följande brödtext:

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

När begäran har skickats returneras följande svar.

  
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

Svaret innehåller följande XML-brödtext.

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

Share via

Gateway version 1 (V1)

Skapa

Förfrågan

URI-parametrar

Rubriker för begäran

Begärandetext

Svarsåtgärder

Statuskod

Svarsrubriker

Svarstext

Exempel på begäran och svar

Ta bort

Förfrågan

URI-parametrar

Rubriker för begäran

Begärandetext

Svarsåtgärder

Statuskod

Svarsrubriker

Svarstext

Exempel på begäran och svar

Hämta

Förfrågan

URI-parametrar

Rubriker för begäran

Begärandetext

Svarsåtgärder

Statuskod

Svarsrubriker

Svarstext

Exempel på begäran och svar

Lista

Förfrågan

URI-parametrar

Rubriker för begäran

Begärandetext

Svarsåtgärder

Statuskod

Svarsrubriker

Svarstext

Exempel på begäran och svar

Återskapa nyckel

Förfrågan

URI-parametrar

Rubriker för begäran

Begärandetext

Svarsåtgärder

Statuskod

Svarsrubriker

Svarstext

Exempel på begäran och svar

Uppdatera

Förfrågan

URI-parametrar

Rubriker för begäran

Begärandetext

Svarsåtgärder

Statuskod

Svarsrubriker

Svarstext

Exempel på begäran och svar

Ytterligare resurser