Data - Update

Odwołanie

Service:: Maps

API Version:: 2.0

Służy do aktualizowania zawartości danych przekazanej 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 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 Update API jest żądaniem HTTP PUT , które umożliwia obiektowi wywołującym aktualizowanie wcześniej przekazanej zawartości danych.

Tego interfejsu API można używać w scenariuszu, takim jak dodawanie lub usuwanie geofencingów do lub z istniejącej kolekcji geofencingów. Geofencences są przekazywane przy użyciu interfejsu API przekazywania danych do użycia w usłudze Azure Maps Geofencing Service.

Należy pamiętać, że interfejs API aktualizacji zastąpi istniejącą zawartość danych i zastąpi ją.

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 aktualizacji

Aby zaktualizować zawartość, użyj PUT żądania. Treść żądania będzie zawierać nowe dane, które zastąpią istniejące dane. Nagłówek Content-Type zostanie ustawiony na typ zawartości danych, a ścieżka będzie zawierać udid dane do zaktualizowania.

Aby na przykład zaktualizować kolekcję geofencingów, które zostały wcześniej przekazane przy użyciu interfejsu API przekazywania, umieść nową zawartość geofencingu w treści żądania. udid Ustaw parametr w ścieżce na udid dane odebrane wcześniej w odpowiedzi interfejsu API przekazywania. Content-Type Ustaw 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 aktualizacji prostego geofencingu. Jest on reprezentowany 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
        }
    }]
}

Wcześniej przekazany geofencing miał promień 100 m. Powyższe żądanie zaktualizuje je do 500 m.

Interfejs API aktualizacji danych wykonuje długotrwałą operację.

Limity aktualizacji 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.

PUT https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=2.0

With optional parameters:

PUT https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=2.0&description={description}

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 dla 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.
description	query		string	Opis, który ma zostać przekazany do przekazania.

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.

Treść żądania

Nazwa	Typ	Opis
UpdateContent	object	Nowa zawartość, która zaktualizuje/zastąpi wcześniej przekazaną zawartość.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LongRunningOperationResult	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	ErrorResponse	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	ErrorResponse	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

Update previously uploaded GeoJSON data containing geometries that represent a collection of geofences

Sample Request

HTTP

PUT https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2.0

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.126986,
          47.639754
        ]
      },
      "properties": {
        "geometryId": "001",
        "radius": 500
      }
    }
  ]
}

Sample Response

Status code:: 200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

Response Body

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/mapData/operations/{operationId}?api-version=1.0
Access-Control-Expose-Headers: Operation-Location

Status code:: 409

{
  "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
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
LongRunningOperationResult	Model odpowiedzi dla interfejsu API operacji Long-Running.
LroStatus	Stan żądania.

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 error.

LongRunningOperationResult

Model odpowiedzi dla interfejsu API operacji Long-Running.

Nazwa	Typ	Opis
created	string	Utworzony znacznik czasu.
error	ErrorDetail	Szczegóły błędu.
operationId	string	Identyfikator dla tej długotrwałej operacji.
status	LroStatus	Stan żądania.
warning	ErrorDetail	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.