Data - List Preview

Referentie

Service:: Maps

API Version:: 1.0

Met de lijstaanvraag kan de aanroeper een lijst ophalen met alle inhoud die eerder is geüpload met behulp van Gegevens uploaden.
Van toepassing op: Prijscategorie S1.

Met deze API kan de aanroeper een lijst ophalen met alle inhoud die eerder is geüpload met behulp van de Api voor het uploaden van gegevens.

Notitie

buitengebruikstelling van Azure Maps Data Service

De Azure Maps Data-service (zowel v1 als v2) is nu afgeschaft en wordt op 16-9-24 buiten gebruik gesteld. Om serviceonderbrekingen te voorkomen, moeten alle aanroepen naar de gegevensservice worden bijgewerkt om de Azure Maps Data Registry-service te gebruiken voor 24-9-09. Zie Gegevensregister maken voor meer informatie.

Aanvraag voor lijst verzenden

Als u alle inhoud van uw kaartgegevens wilt weergeven, doet u een GET aanvraag zonder extra parameters.

Antwoord op lijstgegevens

De Gegevenslijst-API retourneert de volledige lijst met alle gegevens in json indeling. Het antwoord bevat de volgende details voor elke gegevensresource:

udid: de unieke gegevens-id voor de gegevensresource.

location: de locatie van de gegevensresource. Voer een HTTP GET uit op deze locatie om de gegevens te downloaden.

Hier volgt een voorbeeldantwoord dat de udid en location van drie gegevensresources retourneert:

{
    "mapDataList": 
    [
        {
            "udid": "9a1288fa-1858-4a3b-b68d-13a8j5af7d7c",
            "location": "https://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://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://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=1.0

With optional parameters:

GET https://{geography}.atlas.microsoft.com/mapData?subscription-key={subscription-key}&api-version=1.0

URI-parameters

Name	In	Vereist	Type	Description
geography	path	True	string	Deze parameter geeft aan waar de resource Azure Maps Creator zich bevindt. Geldige waarden zijn wij en eu.
api-version	query	True	string	Versienummer van Azure Maps API. Huidige versie is 1.0
subscription-key	query		string	Een van de Azure Maps sleutels die zijn opgegeven vanuit een Azure Map-account. Raadpleeg dit artikel voor meer informatie over het beheren van verificatie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name	Type	Description
200 OK	MapDataListResponse	De aanvraag voor lijstgegevens is voltooid. De hoofdtekst van het antwoord bevat een lijst met alle eerder geüploade gegevens. Headers Content-Type: string
400 Bad Request	ODataErrorResponse	Ongeldige aanvraag: een of meer parameters zijn onjuist opgegeven of sluiten elkaar uit.
401 Unauthorized	ODataErrorResponse	Toegang geweigerd vanwege een ongeldige abonnementssleutel of ongeldig Microsoft Entra ID Bearer-token. Zorg ervoor dat u een geldige sleutel opgeeft voor een actief Azure-abonnement en Kaarten-resource. Controleer anders de WWW-Authenticate-header op foutcode en beschrijving van het opgegeven Microsoft Entra ID bearer-token. Headers WWW-Authenticate: string
403 Forbidden	ODataErrorResponse	Machtigings-, capaciteits- of verificatieproblemen.
404 Not Found	ODataErrorResponse	Niet gevonden: de aangevraagde resource kan niet worden gevonden, maar is in de toekomst mogelijk weer beschikbaar.
500 Internal Server Error	ODataErrorResponse	Er is een fout opgetreden tijdens het verwerken van de aanvraag. Probeert u het later nog eens.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

Zie overzicht van Microsoft identity platform voor meer informatie over Microsoft identity platform.

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

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

List all the previously uploaded data

Sample Request

HTTP

GET https://us.atlas.microsoft.com/mapData?subscription-key=[subscription-key]&api-version=1.0

Sample Response

Status code:: 200

{
  "mapDataList": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "location": "https://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://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://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
      "sizeInBytes": 1650,
      "uploadStatus": "Pending"
    }
  ]
}

Status code:: 400

{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}

Status code:: 401

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}

Status code:: 403

{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}

Status code:: 404

{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}

Status code:: 500

{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definities

Name	Description
MapDataDetailInfo	Gedetailleerde informatie voor de gegevens.
MapDataListResponse	Het antwoordmodel voor de Gegevenslijst-API. Retourneert een lijst met alle eerder geüploade gegevens.
ODataError	Dit object wordt geretourneerd wanneer er een fout optreedt in de Azure Maps-API.
ODataErrorResponse	Dit antwoordobject wordt geretourneerd wanneer er een fout optreedt in de Azure Maps API.

MapDataDetailInfo

Gedetailleerde informatie voor de gegevens.

Name	Type	Description
location	string	De locatie van de gegevens. Voer een HTTP `GET` uit op deze locatie om de gegevens te downloaden.
sizeInBytes	integer	De grootte van de inhoud in bytes.
udid	string	De unieke gegevens-id voor de gegevens.
uploadStatus	string	De huidige uploadstatus van de inhoud.

MapDataListResponse

Het antwoordmodel voor de Gegevenslijst-API. Retourneert een lijst met alle eerder geüploade gegevens.

Name	Type	Description
mapDataList	MapDataDetailInfo[]	Een lijst met alle eerder geüploade gegevens.

ODataError

Dit object wordt geretourneerd wanneer er een fout optreedt in de Azure Maps-API.

Name	Type	Description
code	string	De ODataError-code.
details	ODataError[]	Dit object wordt geretourneerd wanneer er een fout optreedt in de Azure Maps-API.
message	string	Indien beschikbaar, een door mensen leesbare beschrijving van de fout.
target	string	Indien beschikbaar, het doel dat de fout veroorzaakt.

ODataErrorResponse

Dit antwoordobject wordt geretourneerd wanneer er een fout optreedt in de Azure Maps API.

Name	Type	Description
error	ODataError	Dit object wordt geretourneerd wanneer er een fout optreedt in de Azure Maps-API.

Share via