Udostępnij za pośrednictwem


Map Configuration - Get Operation

Służy do sprawdzania stanu procesu tworzenia konfiguracji mapy.

Interfejs Get Operation API jest żądaniem HTTP GET używanym do sprawdzania stanu procesu tworzenia konfiguracji mapy.

Przesyłanie żądania operacji

Aby wyświetlić bieżący postęp operacji konfiguracji mapy, należy użyć GET żądania, w którym operationId dana ścieżka jest identyfikatorem reprezentującym operację.

Odpowiedź operacji

W toku 200-OK kod stanu http jest zwracany bez dodatkowych nagłówków. Jeśli operacja powiedzie się, 200-OK kod stanu HTTP jest zwracany z Resource-Location nagłówkiem .

GET https://{geography}.atlas.microsoft.com/styles/mapconfigurations/operations/{operationId}?api-version=2023-03-01-preview

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.

operationId
path True

string

Identyfikator do wysyłania zapytania o stan żądania utworzenia konfiguracji mapy.

api-version
query True

string

Numer wersji interfejsu API Azure Maps.

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.

Nagłówki

Resource-Location: string

Other Status Codes

ErrorResponse

Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy OAuth2 usługi Azure Active Directory . 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 usługi Azure Active Directory. * 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.

  • Obecnie usługa Azure Active Directory w wersji 1.0 lub 2.0 obsługuje konta służbowe, szkolne i gości, ale nie obsługuje kont osobistych.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

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

subscription-key

Jest to klucz współużytkowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK 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.

Typ: apiKey
W: 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.

Typ: apiKey
W: 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

Przykładowe żądanie

GET https://us.atlas.microsoft.com/styles/mapconfigurations/operations/{operationId}?api-version=2023-03-01-preview

Przykładowa odpowiedź

Resource-Location: https://us.atlas.microsoft.com/styles/mapConfigurations/{operationId}?api-version=2023-03-01-preview
{
  "operationId": "{operationId}",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Get the status of an operation which is still running

Przykładowe żądanie

GET https://us.atlas.microsoft.com/styles/mapconfigurations/operations/{operationId}?api-version=2023-03-01-preview

Przykładowa odpowiedź

{
  "operationId": "{operationId}",
  "created": "2021-04-23T19:14:03.2452596+00:00",
  "status": "Running"
}

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.