Data - Download

Service:

Maps

API Version:

2.0

Gebruik om gegevens te downloaden die eerder zijn geüpload met Behulp van Gegevens uploaden.

Notitie

buitengebruikstelling van gegevensservice Azure Maps

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

De Data Download API is een HTTP-aanvraag GET waarmee de aanroeper een eerder geüploade gegevensinhoud kan downloaden.

U kunt deze API gebruiken in een scenario zoals het downloaden van een bestaande verzameling geofences die u eerder hebt geüpload met behulp van de Api voor het uploaden van gegevens voor gebruik in onze Azure Maps Geofencing Service.

Belangrijk

Door deze functie te gebruiken, gaat u akkoord met de juridische voorwaarden van de preview. Zie de aanvullende voorwaarden voor preview voor meer informatie.

Downloadaanvraag indienen

Als u uw inhoud wilt downloaden, gebruikt u een GET aanvraag waarbij het pad de udid gegevens bevat die u wilt downloaden. U kunt desgewenst ook een Accept header doorgeven om een voorkeur op te geven voor de Content-Type van het antwoord op de gegevens.

Als u bijvoorbeeld een verzameling geofences wilt downloaden die eerder zijn geüpload met behulp van de Upload-API, stelt u de udid parameter in het pad in op de udid van de gegevens die u eerder hebt ontvangen in het antwoord van de upload-API en stelt u de Accept header in op een van de volgende mediatypen:

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

Gegevensantwoord downloaden

De Download-API retourneert een HTTP-antwoord 200 OK als de gegevensbron met de doorgegeven udid wordt gevonden, waarbij de hoofdtekst van het antwoord de inhoud van de gegevensbron bevat.

Er wordt een HTTP-foutreactie 400 Bad Request geretourneerd als de gegevensbron met de doorgegeven udid fout niet wordt gevonden.

Hier volgt een voorbeeld van een antwoordtekst voor een eenvoudige geofence die GeoJSON eerder is geüpload met behulp van de Upload-API:

{
    "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-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.
udid	path	True	string	De unieke gegevens-id voor de inhoud. De udid moet zijn verkregen na een geslaagde aanroep voor het uploaden van gegevens .
api-version	query	True	string	Versienummer van Azure Maps API.

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 in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name	Type	Description
200 OK	file	De aanvraag voor het downloaden van gegevens is voltooid. De antwoordtekst bevat de inhoud voor de doorgegeven in udid. Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream" Headers Content-Type: string
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden. Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. In combinatie met 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.

Als u scenario's wilt implementeren, raden we u aan om 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

• Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps .

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 gebruiksscenario's.

• Zie Microsoft identity platform overzicht 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 Creatie 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 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 wordt 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 over het verloop, de snelheid en de 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 oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

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

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.