Data - List
Użyj polecenia , aby pobrać listę wszystkich wcześniej przekazanych zawartości przy użyciu funkcji przekazywania danych.
Uwaga
Wycofanie usługi Danych w usłudze Azure Maps
Usługa danych usługi 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, wszystkie wywołania usługi Data service będą musiały zostać zaktualizowane 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 List
API to żądanie HTTP GET
, które umożliwia obiektowi wywołującego pobranie listy całej zawartości przekazanej wcześniej przy użyciu interfejsu API przekazywania danych .
Prześlij żądanie listy
Aby wyświetlić listę wszystkich zawartości danych mapy, wyślesz GET
żądanie bez dodatkowych parametrów.
Odpowiedź na dane listy
Interfejs API listy danych zwraca pełną listę wszystkich danych w json
formacie. Odpowiedź zawiera następujące szczegóły dla każdego zasobu danych:
udid — unikatowy identyfikator danych zasobu danych.
location — lokalizacja zasobu danych. Wykonaj żądanie HTTP
GET
w tej lokalizacji, aby pobrać dane.
Oto przykładowa odpowiedź zwracająca udid
zasoby danych i location
z 3:
{
"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
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
geography
|
path | True |
string |
Ten parametr określa, gdzie znajduje się zasób twórcy usługi Azure Maps. Prawidłowe wartości to my i eu. |
api-version
|
query | True |
string |
Numer wersji interfejsu API usługi 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ń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń microsoft Entra ID w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Pomyślnie ukończono żądanie danych. Treść odpowiedzi zawiera listę wszystkich wcześniej przekazanych danych. |
|
Other Status Codes |
Wystąpił nieoczekiwany błąd. |
Zabezpieczenia
AADToken
Są to przepływy protokołu Microsoft Entra OAuth 2.0 . 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 usługi Azure Maps. Mechanizmy kontroli dostępu oparte na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów usługi 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 interfejsów API REST usługi Azure Maps.
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łówka
x-ms-client-id
, aby wskazać, do którego zasobu usługi 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 identyfikatorów entra firmy Microsoft.
* Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
* Użycie zestawu Sdk sieci Web usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
- Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Omówienie platformy tożsamości firmy Microsoft.
Typ:
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 tworzenia konta usługi Azure Maps w witrynie 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 usługi Azure Maps, aby można było bezpiecznie przechowywać klucz.
Typ:
apiKey
W:
query
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny 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.
Typ:
apiKey
W:
header
Przykłady
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"
}
]
}
Definicje
Nazwa | Opis |
---|---|
Data |
Format danych przekazanej zawartości. |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Map |
Szczegółowe informacje dotyczące danych. |
Map |
Model odpowiedzi interfejsu API listy danych. Zwraca listę wszystkich wcześniej przekazanych danych. |
Upload |
Bieżący stan przekazywania zawartości. |
DataFormat
Format danych przekazanej zawartości.
Nazwa | Typ | Opis |
---|---|---|
dwgzippackage |
string |
Pakiet ZIP zawierający plik DWG. |
geojson |
string |
GeoJSON to format wymiany danych geoprzestrzennych oparty na formacie JSON. |
zip |
string |
Skompresowany format danych. |
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 |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
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 |
Obiekt błędu. |
MapData
Szczegółowe informacje dotyczące danych.
Nazwa | Typ | Opis |
---|---|---|
dataFormat |
Format danych przekazanej zawartości. |
|
description |
string |
Bieżący opis. |
location |
string |
Lokalizacja danych. Wykonaj żądanie HTTP |
sizeInBytes |
integer |
Rozmiar zawartości w bajtach. |
udid |
string |
Unikatowy identyfikator danych dla danych. |
uploadStatus |
Bieżący stan przekazywania zawartości. |
MapDataListResult
Model odpowiedzi interfejsu API listy danych. Zwraca listę wszystkich wcześniej przekazanych danych.
Nazwa | Typ | Opis |
---|---|---|
mapDataList |
Map |
Lista wszystkich wcześniej przekazanych danych. |
UploadStatus
Bieżący stan przekazywania zawartości.
Nazwa | Typ | Opis |
---|---|---|
Completed |
string |
Przekazywanie weryfikacji i przetwarzania zostało ukończone |
Failed |
string |
Przekazywanie weryfikacji i/lub niepowodzenia przetwarzania |
Pending |
string |
Przekazywanie jest przetwarzane |