Data - List

Referens

Tjänst:: Maps

API-version:: 2.0

Använd för att hämta en lista över allt innehåll som tidigare laddats upp med datauppladdning.

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 List är en HTTP-begäran GET som gör att anroparen kan hämta en lista över allt innehåll som tidigare laddats upp med hjälp av API:et för datauppladdning .

Skicka listbegäran

Om du vill visa en lista över allt kartdatainnehåll utfärdar du en GET begäran utan ytterligare parametrar.

Svar på listdata

API:et för datalista returnerar den fullständiga listan över alla data i json format. Svaret innehåller följande information för varje dataresurs:

udid – det unika data-ID:t för dataresursen.

location – platsen för dataresursen. Kör en HTTP-begäran GET på den här platsen för att ladda ned data.

Här är ett exempelsvar som returnerar udid och location av 3 dataresurser:

{
    "mapDataList": 
    [
        {
            "udid": "9a1288fa-1858-4a3b-b68d-13a8j5af7d7c",
            "location": "https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0",
            "sizeInBytes": 29920,
            "uploadStatus": "Completed"
        },
        {
            "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
            "location": "https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
            "sizeInBytes": 1339,
            "uploadStatus": "Completed"
        },
        {
            "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
            "location": "https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
            "sizeInBytes": 1650,
            "uploadStatus": "Pending"
        }]
}

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

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.

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ä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 .

Svar

Name	Typ	Description
200 OK	MapDataListResult	Listdatabegäran har slutförts. Svarstexten innehåller en lista över alla tidigare uppladdade data.
Other Status Codes	ErrorResponse	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-idkrä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

List all the previously uploaded data

Exempelbegäran

HTTP

GET https://us.atlas.microsoft.com/mapData?api-version=2.0

Exempelsvar

Statuskod:: 200

{
  "mapDataList": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "location": "https://us.atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0",
      "sizeInBytes": 29920,
      "uploadStatus": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "location": "https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
      "sizeInBytes": 1339,
      "uploadStatus": "Completed"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "location": "https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
      "sizeInBytes": 1650,
      "uploadStatus": "Pending"
    }
  ]
}

Definitioner

Name	Description
DataFormat	Dataformat för det uppladdade innehållet.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
MapData	Detaljerad information om data.
MapDataListResult	Svarsmodellen för dataliste-API:et. Returnerar en lista över alla tidigare uppladdade data.
UploadStatus	Aktuell uppladdningsstatus för innehållet.

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

MapData

Detaljerad information om data.

Name	Typ	Description
dataFormat	DataFormat	Dataformat för det uppladdade innehållet.
description	string	Den aktuella beskrivningen.
location	string	Platsen för data. Kör en HTTP-begäran `GET` på den här platsen för att ladda ned data.
sizeInBytes	integer	Storleken på innehållet i byte.
udid	string	Det unika data-ID:t för data.
uploadStatus	UploadStatus	Aktuell uppladdningsstatus för innehållet.

MapDataListResult

Svarsmodellen för dataliste-API:et. Returnerar en lista över alla tidigare uppladdade data.

Name	Typ	Description
mapDataList	MapData[]	En lista över alla tidigare uppladdade data.

UploadStatus

Aktuell uppladdningsstatus för innehållet.

Name	Typ	Description
Completed	string	Uppladdningsverifiering och bearbetning har slutförts
Failed	string	Uppladdningsverifiering och/eller bearbetningsfel
Pending	string	Uppladdningen bearbetas

Dela via