Dataset - Create

Usługa:

Maps Creator

Wersja interfejsu API:

2023-03-01-preview

Użyj polecenia , aby utworzyć zestaw danych.

Interfejs Create API to żądanie HTTPPOST, które umożliwia obiektowi wywołującego utworzenie zestawu danych na podstawie danych przekazanych do rejestru danych Azure Maps i przekonwertowane przy użyciu usługi konwersji Azure Maps. Zestaw danych można również utworzyć bezpośrednio przy użyciu danych przekazanych do rejestru Azure Maps Data Registry, pod warunkiem że przekazane dane są zip plików GeoJSON zgodnych z formatem ontologii obiektu. Aby uzyskać więcej informacji na temat usługi rejestru danych, zobacz Jak utworzyć rejestr danych.

Aby uzyskać więcej informacji, zobacz Tworzenie zestawu danych przy użyciu pakietu GeoJson

Prześlij żądanie utworzenia

Aby utworzyć zestaw danych, prześlij POST żądanie z wymaganymi parametrami. Interfejs API tworzenia to długotrwała operacja.

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2023-03-01-preview

Z parametrami opcjonalnymi:

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&udid={udid}&outputOntology=facility-2.0&datasetId={datasetId}&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.
conversionId	query		string	Identyfikator tworzenia zestawu danych. Element conversionId musi zostać uzyskany z pomyślnego wywołania interfejsu API konwersji usługi konwersji. Na wywołanie interfejsu API można podać tylko jeden identyfikator konwersji. conversionId i udid są wzajemnie wykluczające się parametry.
datasetId	query		string	Identyfikator zestawu danych do dołączenia.
description	query		string	Opis, który ma zostać podany zestawowi danych.
outputOntology	query		outputOntology	Ontology dla przekazanego pakietu zip zawierającego pliki GeoJSON. parametr outputOntology jest wymagany, jeśli podano identyfikator udid, jednak wzajemnie wyklucza się z identyfikatorem konwersji. Obecnie obsługiwana jest tylko wartość facility-2.0 .
udid	query		string	Unikatowy identyfikator danych (udid) do utworzenia zestawu danych. Musi być taki sam udid , jak podczas tworzenia rejestru danych. Tylko jeden identyfikator można podać na wywołanie interfejsu API. parametr outputOntology musi być podany z identyfikatorem udid. conversionId i udid są wzajemnie wykluczające się parametry.

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
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 OAuth2 usługi Azure Active Directory . 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 usługi Azure Active Directory. * 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.

• 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ługują 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ó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

Create dataset from a converted CAD file provided by conversionId

Create dataset from a zip of GeoJSON files provided by udid

Create dataset with Udid and append to it a dataset created with conversionId

Create dataset with Udid and append to it a dataset created with udid

Create dataset from a converted CAD file provided by conversionId

Przykładowe żądanie

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&outputOntology=facility-2.0

Przykładowa odpowiedź

Kod stanu:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Create dataset from a zip of GeoJSON files provided by udid

Przykładowe żądanie

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&udid={udid}&outputOntology=facility-2.0

Przykładowa odpowiedź

Kod stanu:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Create dataset with Udid and append to it a dataset created with conversionId

Przykładowe żądanie

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&udid={udid}&outputOntology=facility-2.0&datasetId={conversionId}

Przykładowa odpowiedź

Kod stanu:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Create dataset with Udid and append to it a dataset created with udid

Przykładowe żądanie

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&udid={udid}&outputOntology=facility-2.0&datasetId={udid}

Przykładowa odpowiedź

Kod stanu:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
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
outputOntology	Ontology dla przekazanego pakietu zip zawierającego pliki GeoJSON. parametr outputOntology jest wymagany, jeśli podano identyfikator udid, jednak wzajemnie wyklucza się z identyfikatorem konwersji. Obecnie obsługiwana jest tylko wartość facility-2.0 .

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.

outputOntology

Ontology dla przekazanego pakietu zip zawierającego pliki GeoJSON. parametr outputOntology jest wymagany, jeśli podano identyfikator udid, jednak wzajemnie wyklucza się z identyfikatorem konwersji. Obecnie obsługiwana jest tylko wartość facility-2.0 .

Nazwa	Typ	Opis
facility-2.0	string