Data - Download

Referens

Service:: Maps

API Version:: 2.0

Använd för att ladda ned data som tidigare laddats upp med datauppladdning.

Anteckning

Azure Maps datatjänsten dras tillbaka

Tjänsten Azure Maps Data (både v1 och v2) är nu inaktuell och kommer att dras tillbaka den 24-09-16. För att undvika tjänststörningar måste alla anrop till datatjänsten uppdateras för att använda Azure Maps Data Registry-tjänsten senast den 16/16/24. Mer information finns i Skapa dataregister.

API:et Data Download är och HTTP-begäran GET som gör att anroparen kan ladda ned ett tidigare uppladdat datainnehåll.

Du kan använda det här API:et i ett scenario som att ladda ned en befintlig samling geofences som laddats upp tidigare med hjälp av API:et för datauppladdning för användning i vår Azure Maps Geofencing Service.

Viktigt

Genom att använda den här funktionen godkänner du de juridiska villkoren för förhandsversionen. Mer information finns i Tilläggsvillkor för förhandsversion .

Skicka nedladdningsbegäran

Om du vill ladda ned ditt innehåll använder du en GET begäran där sökvägen innehåller de data som udid ska laddas ned. Du kan också skicka in en Accept rubrik för att ange en inställning för Content-Type datasvaret.

Om du till exempel vill ladda ned en samling geofences som tidigare laddats upp med api:et Upload anger du udid parametern i sökvägen till udid för de data som togs emot tidigare i api-uppladdningssvaret Accept och anger huvudet till någon av följande medietyper:

application/json
application/vnd.geo+json
application/octet-stream

Ladda ned datasvar

Hämtnings-API:et returnerar ett HTTP-svar 200 OKudid om dataresursen med det skickade objektet hittas, där svarstexten innehåller dataresursens innehåll.

Ett HTTP-felsvar 400 Bad Request returneras om dataresursen med det skickade udid inte hittas.

Här är ett exempel på en svarstext för en enkel geofence som representeras i GeoJSON uppladdad tidigare med api:et Upload:

{
    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-122.126986, 47.639754]
        },
        "properties": {
            "geometryId": "001",
            "radius": 500
        }
    }]
}

GET https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=2.0

URI-parametrar

Name	I	Obligatorisk	Typ	Description
geography	path	True	string	Den här parametern anger var resursen Azure Maps Creator finns. Giltiga värden är oss och EU.
udid	path	True	string	Det unika data-ID:t för innehållet. `udid` Måste ha hämtats från ett lyckat datauppladdningsanrop.
api-version	query	True	string	Versionsnummer för Azure Maps API.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps hanteringsplans konto-API. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	file	Datahämtningsbegäran har slutförts. Svarstexten innehåller innehållet för som skickas i `udid`. Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream" Headers Content-Type: string
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel. Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

file

Datahämtningsbegäran har slutförts. Svarstexten innehåller innehållet för som skickas i udid.

Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

Headers

Content-Type: string

Other Status Codes

ErrorResponse

Det uppstod ett oväntat fel.

Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API :et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Mer information om Microsofts identitetsplattform finns i Microsofts identitetsplattform översikt.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Det här är en delad nyckel som etableras när du Skapa ett Azure Maps-konto i Azure Portal eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de utfärdas i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruk och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences

Sample Request

HTTP

GET https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2.0

Sample Response

Status code:: 200

"{file}"

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

Data - Download

Skicka nedladdningsbegäran

Ladda ned datasvar

URI-parametrar

Begärandehuvud

Svar

Säkerhet

AADToken

Kommentarer

Scopes

subscription-key

SAS Token

Exempel

Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences

Sample Request

Sample Response

Definitioner

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Ytterligare resurser