Data - Upload
Använd för att ladda upp datainnehåll till ett Azure Maps-konto.
Anteckning
Azure Maps-datatjänsten dras tillbaka
Azure Maps-datatjänsten (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 24-09-16. Mer information finns i Skapa dataregister.
API:et Data Upload
är en HTTP-begäran POST
som gör att anroparen kan ladda upp datainnehåll till Azure Maps-tjänsten.
Du kan använda det här API:et i ett scenario som att ladda upp en samling Geofences i GeoJSON
formatet för användning i vår Geofencing-tjänst för Azure Maps.
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 uppladdningsbegäran
Om du vill ladda upp ditt innehåll använder du en POST
begäran. Begärandetexten innehåller de data som ska laddas upp. Frågeparametern dataFormat
innehåller dataformatet. dataSharingLevel
Frågeparametern kan innehålla delningsnivån för data. Rubriken Content-Type
anges till innehållstypen för data.
Om du till exempel vill ladda upp en samling geofences i GeoJSON
format anger du begärandetexten till geofence-innehållet.
dataFormat
Ställ in frågeparametern på geojson och ställ in Content-Type
rubriken på någon av följande medietyper:
application/json
application/vnd.geo+json
application/octet-stream
Här är ett exempel på begärandetext för att ladda upp en enkel Geofence som representeras som en cirkelgeometri med hjälp av en mittpunkt och en radie. Exemplet nedan finns i GeoJSON
:
{
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [-122.126986, 47.639754]
},
"properties": {
"geometryId": "001",
"radius": 500
}
}]
}
API:et för datauppladdning utför en tidskrävande åtgärd.
Dataöverföringsgränser
Tänk på att alla Azure Maps-konton för närvarande har en datalagringsgräns. När lagringsgränsen har nåtts returnerar alla nya API-anrop för uppladdning ett 409 Conflict
http-felsvar. Du kan alltid använda API:et för databorttagning för att ta bort gammalt/oanvänt innehåll och skapa utrymme för nya uppladdningar.
POST https://{geography}.atlas.microsoft.com/mapData?api-version=2.0&dataFormat={dataFormat}
POST https://{geography}.atlas.microsoft.com/mapData?api-version=2.0&description={description}&dataFormat={dataFormat}
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Den här parametern anger var Azure Maps Creator-resursen finns. Giltiga värden är oss och EU. |
api-version
|
query | True |
string |
Versionsnummer för Azure Maps API. |
data
|
query | True |
Dataformat för det innehåll som laddas upp. |
|
description
|
query |
string |
Beskrivningen som ska ges till uppladdningen. |
Begärandehuvud
Media Types: "application/json", "application/octet-stream"
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äkerhetsmodellen. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar . |
Begärandetext
Media Types: "application/json", "application/octet-stream"
Name | Typ | Description |
---|---|---|
UploadContent |
object |
Det innehåll som ska laddas upp. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Åtgärden körs eller slutförs. Om åtgärden lyckades använder du Resource-Location-huvudet för att hämta sökvägen till resultatet. Sidhuvuden Resource-Location: string |
|
202 Accepted |
Begäran accepterad: Begäran har godkänts för bearbetning. Använd URL:en i Operation-Location-huvudet för att hämta status. Sidhuvuden Operation-Location: string |
|
Other Status Codes |
Datalagringsgränsen nås på Azure Maps-kontot. Du kan alltid använda API:et för databorttagning för att ta bort gammalt/oanvänt innehåll och skapa utrymme för nya uppladdningar. |
|
Other Status Codes |
Det uppstod ett oväntat fel. |
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 REST-API:er för Azure Maps. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton 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 till Rest-API:er för Azure Maps.
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-id
kräver att huvudet används för att ange vilken Azure Maps-resurs 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 åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
* Användning av Webb-SDK för Azure Maps möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
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 skapar ett Azure Maps-konto i Azure-portalen eller använder 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 få åtkomst till REST-API:er för Azure Maps så att din nyckel kan lagras på ett säkert sätt.
Typ:
apiKey
I:
query
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, 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.
Typ:
apiKey
I:
header
Exempel
Upload GeoJSON data containing geometries that represent a collection of geofences
Exempelbegäran
POST https://us.atlas.microsoft.com/mapData?api-version=2.0&dataFormat=geojson
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.126986,
47.639754
]
},
"properties": {
"geometryId": "001",
"radius": 500
}
}
]
}
Exempelsvar
Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0
{
"operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"created": "2021-04-20T22:43:14.9401559+00:00",
"status": "Succeeded"
}
Operation-Location: https://us.atlas.microsoft.com/mapData/operations/{udid}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location
{
"error": {
"code": "409 Conflict",
"message": "The data storage limit is reached on the Azure Maps account. You can always use the Data Delete API to delete old/unused content and create space for new uploads."
}
}
Definitioner
Name | Description |
---|---|
Data |
Dataformat för det uppladdade innehållet. |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Long |
Svarsmodellen för ett Long-Running Operations-API. |
Lro |
Statustillståndet för begäran. |
DataFormat
Dataformat för det uppladdade innehållet.
Name | Typ | Description |
---|---|---|
dwgzippackage |
string |
ZIP-paket som innehåller DWG-fil. |
geojson |
string |
GeoJSON är ett JSON-baserat geospatialt datautbytesformat. |
zip |
string |
Komprimerat dataformat. |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Den ytterligare informationen. |
type |
string |
Ytterligare informationstyp. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
LongRunningOperationResult
Svarsmodellen för ett Long-Running Operations-API.
Name | Typ | Description |
---|---|---|
created |
string |
Den skapade tidsstämpeln. |
error |
Felinformationen. |
|
operationId |
string |
ID:t för den här långvariga åtgärden. |
status |
Statustillståndet för begäran. |
|
warning |
Felinformationen. |
LroStatus
Statustillståndet för begäran.
Name | Typ | Description |
---|---|---|
Failed |
string |
Begäran har ett eller flera fel. |
NotStarted |
string |
Begäran har inte påbörjat bearbetningen ännu. |
Running |
string |
Begäran har börjat bearbetas. |
Succeeded |
string |
Begäran har slutförts. |