Data - Download

Service:

Maps

API Version:

2.0

Służy do pobierania danych przekazanych wcześniej przy użyciu funkcji przekazywania danych.

Uwaga

wycofanie usługi danych Azure Maps

Usługa danych Azure Maps (wersja 1 i wersja 2) jest teraz przestarzała i zostanie wycofana w dniu 16.16.24. Aby uniknąć przerw w działaniu usługi, należy zaktualizować wszystkie wywołania usługi Data Service w celu korzystania z usługi Azure Maps Data Registry przez 9/16/24. Aby uzyskać więcej informacji, zobacz Jak utworzyć rejestr danych.

Interfejs Data Download API to i żądanie HTTP GET , które umożliwia obiekt wywołujący pobranie wcześniej przekazanej zawartości danych.

Ten interfejs API można użyć w scenariuszu, takim jak pobranie istniejącej kolekcji geofencence przekazanych wcześniej przy użyciu interfejsu API przekazywania danych do użycia w usłudze Azure Maps Geofencing Service.

Ważne

Korzystając z tej funkcji, zgadzasz się na postanowienia prawne dotyczące wersji zapoznawczej. Aby uzyskać dodatkowe informacje, zobacz dodatkowe warunki uzupełniające w wersji zapoznawczej .

Prześlij żądanie pobierania

Aby pobrać zawartość, użyj GET żądania, w którym ścieżka będzie zawierać udid dane do pobrania. Opcjonalnie możesz również przekazać nagłówek w Accept celu określenia preferencji odpowiedzi Content-Type na dane.

Aby na przykład pobrać kolekcję geofenców przekazanych wcześniej przy użyciu interfejsu API przekazywania, ustaw udid parametr w ścieżce do udid danych odebranych wcześniej w odpowiedzi interfejsu API przekazywania i ustaw Accept nagłówek na jeden z następujących typów multimediów:

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

Pobieranie odpowiedzi na dane

Interfejs API pobierania zwróci odpowiedź HTTP 200 OK , jeśli zasób danych z przekazanym elementem udid zostanie znaleziony, gdzie treść odpowiedzi będzie zawierać zawartość zasobu danych.

Odpowiedź o błędzie HTTP 400 Bad Request zostanie zwrócona, jeśli zasób danych z przekazanym elementem udid nie zostanie znaleziony.

Oto przykładowa treść odpowiedzi dla prostego geofencingu reprezentowanego wcześniej przy GeoJSON użyciu interfejsu API przekazywania:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
geography	path	True	string	Ten parametr określa, gdzie znajduje się zasób Azure Maps Creator. Prawidłowe wartości to my i eu.
udid	path	True	string	Unikatowy identyfikator danych zawartości. Element udid musi zostać uzyskany z pomyślnego wywołania przekazywania danych .
api-version	query	True	string	Numer wersji interfejsu API Azure Maps.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	file	Żądanie pobierania danych zostało ukończone pomyślnie. Treść odpowiedzi będzie zawierać zawartość przekazanego elementu udid. Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream" Headers Content-Type: string
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd. Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

Zabezpieczenia

AADToken

Są to przepływy protokołu OAuth 2.0 Microsoft Entra. W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

• Ta definicja zabezpieczeń wymaga użycia nagłówkax-ms-client-id, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami .

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje Tożsamość Microsoft Entra. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

• Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas Twórca konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST Azure Maps w celu bezpiecznego przechowywania klucza.

Type: apiKey
In: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Type: apiKey
In: header

Przykłady

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

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.