Udostępnij za pośrednictwem

Conversion - Convert

  • Odwołanie
Usługa:
Maps Creator
Wersja interfejsu API:
2.0

Służy do konwertowania wcześniej zaimportowanego pakietu rysunkowego na dane mapy.

Interfejs Conversion API to żądanie HTTPPOST, które umożliwia obiekt wywołujący importowanie zestawu plików projektowych DWG jako spakowanego pakietu rysunkowego do Azure Maps. Pakiet rysunkowy jest odwoływał się do używanego udid podczas przekazywania do rejestru danych. Aby uzyskać więcej informacji na temat usługi rejestru danych, zobacz Jak utworzyć rejestr danych.

Konwertowanie pakietu DWG

Interfejs API konwersji wykonuje długotrwałą operację.

Debugowanie problemów z pakietem DWG

W trakcie procesu konwersji, jeśli występują problemy z błędami pakietu DWG i ostrzeżeniami są udostępniane w odpowiedzi wraz z pakietem diagnostycznym w celu wizualizacji i diagnozowania tych problemów. Jeśli wystąpią problemy z pakietem DWG, proces stanu operacji konwersji, jak opisano poniżej , zwraca lokalizację pakietu diagnostycznego , który można pobrać przez obiekt wywołujący, aby ułatwić im wizualizowanie i diagnozowanie tych problemów. Lokalizację pakietu diagnostycznego można znaleźć w sekcji właściwości odpowiedzi stanu operacji konwersji i wygląda następująco:

{
    "properties": {
        "diagnosticPackageLocation": "https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0"                
    }            
}

Pakiet diagnostyczny można pobrać, wykonując HTTP GET żądanie w pliku diagnosticPackageLocation. Aby uzyskać więcej informacji na temat sposobu używania narzędzia do wizualizowania i diagnozowania wszystkich błędów i ostrzeżeń, zobacz Rysunek Wizualizator błędów.

Operacja konwersji zostanie oznaczona jako powodzenie , jeśli wystąpi zero lub więcej ostrzeżeń, ale zostanie oznaczona jako niepowodzenie , jeśli wystąpią jakiekolwiek błędy.

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0
Z parametrami opcjonalnymi: 
POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-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.
api-version
 query True

string

Numer wersji interfejsu API Azure Maps.
outputOntology
 query True

OutputOntology

Wersja ontologii wyjściowej. "facility-2.0" jest obecnie jedyną obsługiwaną wartością. Zapoznaj się z tym artykułem, aby uzyskać więcej informacji na temat dzienników Azure Maps Twórca.
udid
 query True

string

Unikatowy identyfikator danych (udid) dla zawartości. Musi być taki sam udid , jak podczas tworzenia rejestru danych.
description
 query

string

Użytkownik podał opis konwertowanej zawartości.

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.

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
202 Accepted

Żądanie zaakceptowane: żądanie zostało zaakceptowane do przetwarzania. Aby uzyskać stan, użyj adresu URL w nagłówku Operation-Location.

Nagłówki

Operation-Location: string
Other Status Codes

ErrorResponse

Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu OAuth 2.0 Microsoft Entra. 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 Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów 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 Azure Maps interfejsów API REST.

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łówkax-ms-client-id, aby wskazać, do którego zasobu 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 Tożsamość Microsoft Entra. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

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ólny aprowizowany podczas tworzenia konta Azure Maps w 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 Azure Maps w celu bezpiecznego przechowywania klucza.

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 Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem 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

Convert previously uploaded DWG Package

Przykładowe żądanie

POST https://us.atlas.microsoft.com/conversions?api-version=2.0&udid=25084fb7-307a-4720-8f91-7952a0b91012&outputOntology=facility-2.0

Przykładowa odpowiedź

Kod stanu:
200 
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"
}
Kod stanu:
202 
Operation-Location: https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

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

Wersja ontologii wyjściowej. "facility-2.0" jest obecnie jedyną obsługiwaną wartością. Zapoznaj się z tym artykułem, aby uzyskać więcej informacji na temat dzienników Azure Maps Twórca.

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 błędu.

LongRunningOperationResult

Model odpowiedzi dla interfejsu API operacji Long-Running.

Nazwa Typ Opis
created

string

Utworzona sygnatura czasowa.
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.

OutputOntology

Wersja ontologii wyjściowej. "facility-2.0" jest obecnie jedyną obsługiwaną wartością. Zapoznaj się z tym artykułem, aby uzyskać więcej informacji na temat dzienników Azure Maps Twórca.

Nazwa Typ Opis
facility-2.0

string

Ontologia obiektu określa, jak Azure Maps Twórca wewnętrznie przechowuje dane obiektu w zestawie danych twórcy.