Dataset - Create

Service:

Maps Creator

API Version:

2.0

Użyj polecenia , aby utworzyć zestaw danych.

Interfejs Create API to żądanie HTTP POST , które przyjmuje conversionId wartość przekonwertowanego pakietu rysunkowego i zwraca datasetId właściwość nowo utworzonego zestawu danych. Aby uzyskać więcej informacji, zobacz Tworzenie zestawu danych.

To żądanie można użyć w scenariuszu, takim jak przekazywanie pakietu zip DWG dla budynku, konwertowanie pakietu zip przy użyciu usługi konwersji Azure Maps i tworzenie zestawu danych z przekonwertowanego pakietu zip. Utworzony zestaw danych może służyć do tworzenia zestawów kafelków przy użyciu usługi zestawu kafelków Azure Maps i można wykonywać zapytania za pośrednictwem usługi Azure Maps WFS.

Prześlij żądanie utworzenia

Aby utworzyć zestaw danych, użyjesz POST żądania, w którym conversionId parametr zapytania jest identyfikatorem reprezentującym przekonwertowany pakiet zip DWG, datasetId parametr jest identyfikatorem wcześniej utworzonego zestawu danych do dołączenia z bieżącym zestawem danych, a opcjonalnie description parametr zapytania będzie zawierać opis (jeśli nie podano opisu domyślnego opisu).

Interfejs API tworzenia to długotrwała operacja.

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}

With optional parameters:

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}&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	True	string	Unikatowy identyfikator użyty do utworzenia zestawu danych. Element conversionId musi zostać uzyskany z pomyślnego wywołania interfejsu API konwersji usługi konwersji i może być dostarczany z wieloma parametrami zapytania o tej samej nazwie (jeśli podano więcej niż jeden).
datasetId	query		string	Identyfikator zestawu danych do dołączenia. Zestaw danych musi pochodzić z poprzedniego wywołania tworzenia zestawu danych zgodnego z identyfikatorem zestawu danych
description	query		string	Opis, który ma zostać podany zestawowi danych.

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

• 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ó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.

Type: apiKey
In: 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.

Type: apiKey
In: header

Przykłady

Create dataset from a converted CAD file provided by conversionId

Sample Request

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2.0&conversionId=[conversionId]

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/datasets/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.

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.