Data - List
Gebruik om een lijst op te halen met alle inhoud die eerder is geüpload met Behulp van Gegevens uploaden.
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 Data-service worden bijgewerkt om de Azure Maps Data Registry-service te gebruiken voor 16-9-24. Zie Gegevensregister maken voor meer informatie.
De Data List
API is een HTTP-aanvraag GET
waarmee de aanroeper een lijst kan ophalen van alle inhoud die eerder is geüpload met behulp van de Api voor het uploaden van gegevens .
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-aanvraag
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://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-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Deze parameter geeft aan waar de Azure Maps Creator-resource zich bevindt. Geldige waarden zijn wij en eu. |
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 wilt gebruiken, raadpleegt u de volgende artikelen voor hulp. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De aanvraag voor lijstgegevens is voltooid. De hoofdtekst van het antwoord bevat een lijst met alle eerder geüploade gegevens. |
|
Other Status Codes |
Er is een onverwachte fout opgetreden. |
Beveiliging
AADToken
Dit zijn de Microsoft Entra OAuth 2.0-stromen . Wanneer het wordt gekoppeld 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-resourceaccounts 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 het mogelijk om een toepassing op basis van configuraties in te stellen 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 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 beschikbaar gemaakte 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
GET https://us.atlas.microsoft.com/mapData?api-version=2.0
Sample response
{
"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"
}
]
}
Definities
Name | Description |
---|---|
Data |
Gegevensindeling van de geüploade inhoud. |
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
Map |
Gedetailleerde informatie voor de gegevens. |
Map |
Het antwoordmodel voor de Gegevenslijst-API. Retourneert een lijst met alle eerder geüploade gegevens. |
Upload |
De huidige uploadstatus van de inhoud. |
DataFormat
Gegevensindeling van de geüploade inhoud.
Name | Type | Description |
---|---|---|
dwgzippackage |
string |
ZIP-pakket met DWG-bestand. |
geojson |
string |
GeoJSON is een indeling voor georuimtelijke gegevensuitwisseling op basis van JSON. |
zip |
string |
Gecomprimeerde gegevensindeling. |
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 |
Aanvullende informatie over de fout. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
MapData
Gedetailleerde informatie voor de gegevens.
Name | Type | Description |
---|---|---|
dataFormat |
Gegevensindeling van de geüploade inhoud. |
|
description |
string |
De huidige beschrijving. |
location |
string |
De locatie van de gegevens. Voer een HTTP-aanvraag |
sizeInBytes |
integer |
De grootte van de inhoud in bytes. |
udid |
string |
De unieke gegevens-id voor de gegevens. |
uploadStatus |
De huidige uploadstatus van de inhoud. |
MapDataListResult
Het antwoordmodel voor de Gegevenslijst-API. Retourneert een lijst met alle eerder geüploade gegevens.
Name | Type | Description |
---|---|---|
mapDataList |
Map |
Een lijst met alle eerder geüploade gegevens. |
UploadStatus
De huidige uploadstatus van de inhoud.
Name | Type | Description |
---|---|---|
Completed |
string |
Validatie en verwerking van uploaden voltooid |
Failed |
string |
Fout bij uploadvalidatie en/of verwerking |
Pending |
string |
Uploaden wordt verwerkt |