Data - Get Operation
Służy do sprawdzania stanu żądania przekazywania danych i pobierania wartości po zakończeniu udid
.
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 Get Operation
API jest żądaniem HTTP GET
, które umożliwia wywołującym sprawdzenie stanu operacji przekazywania danych i pobranie wartości po zakończeniu udid
. Ta ścieżka zostanie uzyskana z wywołania polecenia POST /mapData. W toku kod odpowiedzi HTTP 200 zostanie zwrócony bez dodatkowych nagłówków , a następnie kod odpowiedzi HTTP 200 z nagłówkiem Resource-Location
po pomyślnym ukończeniu.
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 .
GET https://{geography}.atlas.microsoft.com/mapData/operations/{operationId}?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. |
operation
|
path | True |
string |
Identyfikator do wysyłania zapytania o stan żądania przekazania danych. |
api-version
|
query | True |
string |
Numer wersji interfejsu API Azure Maps. |
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 |
|
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
Get the status of an operation which has finished successfully |
Get the status of an operation which is still running |
Get the status of an operation which has finished successfully
Sample Request
GET https://us.atlas.microsoft.com/mapData/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0
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"
}
Get the status of an operation which is still running
Sample Request
GET https://us.atlas.microsoft.com/mapData/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0
Sample Response
{
"operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"created": "2021-04-23T19:14:03.2452596+00:00",
"status": "Running"
}
Definicje
Nazwa | Opis |
---|---|
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. |
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. |