Data - Upload
Użyj polecenia , aby przekazać zawartość danych do konta Azure Maps.
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 24.09.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 do 24.09.16.24. Aby uzyskać więcej informacji, zobacz Jak utworzyć rejestr danych.
Interfejs Data Upload
API to żądanie HTTPPOST
, które umożliwia wywołującym przekazywanie zawartości danych do usługi Azure Maps.
Tego interfejsu API można używać w scenariuszu, takim jak przekazywanie kolekcji geofencences w GeoJSON
formacie, do użycia w usłudze Azure Maps Geofencing Service.
Ważne
Korzystając z tej funkcji, akceptujesz postanowienia prawne dotyczące wersji zapoznawczej. Aby uzyskać dodatkowe informacje, zobacz Warunki uzupełniające wersji zapoznawczej .
Prześlij żądanie przekazania
Aby przekazać zawartość, użyj POST
żądania. Treść żądania będzie zawierać dane do przekazania. dataFormat
Parametr zapytania będzie zawierać format danych. dataSharingLevel
Parametr zapytania może zawierać poziom udostępniania danych. Nagłówek Content-Type
zostanie ustawiony na typ zawartości danych.
Aby na przykład przekazać kolekcję geofencingów w GeoJSON
formacie, ustaw treść żądania na zawartość geofencingu. dataFormat
Ustaw parametr zapytania na geojson i ustaw Content-Type
nagłówek na jeden z następujących typów nośników:
application/json
application/vnd.geo+json
application/octet-stream
Oto przykładowa treść żądania przekazywania prostego geofencingu reprezentowanego jako geometria okręgu przy użyciu punktu środkowego i promienia. Poniższy przykład znajduje się w pliku GeoJSON
:
{
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [-122.126986, 47.639754]
},
"properties": {
"geometryId": "001",
"radius": 500
}
}]
}
Interfejs API przekazywania danych wykonuje długotrwałą operację.
Limity przekazywania danych
Należy pamiętać, że obecnie każde konto Azure Maps ma limit magazynu danych. Po osiągnięciu limitu magazynu wszystkie nowe wywołania interfejsu API przekazywania zwracają 409 Conflict
odpowiedź o błędzie HTTP. Zawsze możesz użyć interfejsu API usuwania danych , aby usunąć starą/nieużywaną zawartość i utworzyć miejsce na nowe przekazywanie.
POST https://{geography}.atlas.microsoft.com/mapData?api-version=2.0&dataFormat={dataFormat}
POST https://{geography}.atlas.microsoft.com/mapData?api-version=2.0&description={description}&dataFormat={dataFormat}
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. |
api-version
|
query | True |
string |
Numer wersji interfejsu API Azure Maps. |
data
|
query | True |
Format danych przekazywanej zawartości. |
|
description
|
query |
string |
Opis, który ma zostać przekazany do przekazania. |
Nagłówek żądania
Media Types: "application/json", "application/octet-stream"
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. |
Treść żądania
Media Types: "application/json", "application/octet-stream"
Nazwa | Typ | Opis |
---|---|---|
UploadContent |
object |
Zawartość do przekazania. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Operacja jest uruchomiona lub ukończona. Jeśli operacja zakończyła się pomyślnie, użyj nagłówka Resource-Location, aby uzyskać ścieżkę do wyniku. Headers Resource-Location: string |
|
202 Accepted |
Zaakceptowano żądanie: żądanie zostało zaakceptowane do przetwarzania. Aby uzyskać stan, użyj adresu URL w nagłówku Operation-Location. Headers Operation-Location: string |
|
Other Status Codes |
Osiągnięto limit magazynu danych na koncie Azure Maps. Zawsze możesz użyć interfejsu API usuwania danych , aby usunąć starą/nieużywaną zawartość i utworzyć miejsce na nowe przekazywanie. |
|
Other Status Codes |
Wystąpił nieoczekiwany błąd. |
Zabezpieczenia
AADToken
Są to przepływy Microsoft Entra OAuth 2.0. Po 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 Azure Maps konta zasobu 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ęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi 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
w celu wskazania, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps .
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 poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
* Użycie zestawu AZURE MAPS Web SDK umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków 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ółużytkowany 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.
Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do wszystkich interfejsów API REST. Innymi słowy, ten klucz może służyć 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 Azure Maps interfejsów API REST, aby klucz mógł być bezpiecznie przechowywany.
Type:
apiKey
In:
query
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji list sygnatur dostępu współdzielonego na zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure oraz szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej bezpieczny 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 SAS.
Type:
apiKey
In:
header
Przykłady
Upload GeoJSON data containing geometries that represent a collection of geofences
Sample Request
POST https://us.atlas.microsoft.com/mapData?api-version=2.0&dataFormat=geojson
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.126986,
47.639754
]
},
"properties": {
"geometryId": "001",
"radius": 500
}
}
]
}
Sample Response
Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0
{
"operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"created": "2021-04-20T22:43:14.9401559+00:00",
"status": "Succeeded"
}
Operation-Location: https://us.atlas.microsoft.com/mapData/operations/{udid}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location
{
"error": {
"code": "409 Conflict",
"message": "The data storage limit is reached on the Azure Maps account. You can always use the Data Delete API to delete old/unused content and create space for new uploads."
}
}
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 |
Long |
Model odpowiedzi dla interfejsu API operacji Long-Running. |
Lro |
Stan żądania. |
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 |
Format skompresowanych 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 error. |
LongRunningOperationResult
Model odpowiedzi dla interfejsu API operacji Long-Running.
Nazwa | Typ | Opis |
---|---|---|
created |
string |
Utworzony znacznik czasu. |
error |
Szczegóły błędu. |
|
operationId |
string |
Identyfikator dla tej długotrwałej operacji. |
status |
Stan żądania. |
|
warning |
Szczegóły błędu. |
LroStatus
Stan żądania.
Nazwa | Typ | Opis |
---|---|---|
Failed |
string |
Żądanie ma co najmniej jeden błąd. |
NotStarted |
string |
Żądanie nie rozpoczęło jeszcze przetwarzania. |
Running |
string |
Żądanie rozpoczęło przetwarzanie. |
Succeeded |
string |
Żądanie zostało pomyślnie ukończone. |