Data Registry - Register Or Replace

Service:

Maps

API Version:

2023-06-01

Służy do rejestrowania danych przechowywanych na koncie usługi Azure Storage przy użyciu konta Azure Maps.

Interfejs Register API to żądanie HTTP PUT używane do rejestrowania danych na koncie usługi Azure Storage przy użyciu konta Azure Maps. Maksymalny rozmiar pliku, który można zarejestrować, to jeden gigabajt.

Jest to przydatne w scenariuszach, takich jak rejestrowanie kolekcji geofencences w GeoJSON formacie używanym w usłudze Azure Maps Geofencing Service lub rejestrowanie zestawu plików projektowych DWG jako spakowanego pakietu rysunkowego do użycia w usłudze konwersji twórców Azure Maps.

Punkt końcowy usługi rejestru danych jest ograniczony do regionu konta Azure Maps i nie jest dostępny dla kont globalnych Azure Maps.

Prześlij żądanie rejestracji lub zastąpienia

Żądania Register i Replace to zarówno długotrwałe operacje, które zawierają obiekt JSON obiektu AzureBlob w treści żądania, które definiuje szczegóły rejestru danych.

PUT https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?api-version=2023-06-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
geography	path	True	string	Ten parametr określa, gdzie znajduje się konto Azure Maps. Prawidłowe wartości to nas (Wschodnie stany USA, Zachodnio-środkowe stany USA, Zachodnie stany USA 2) i eu (Europa Północna, Europa Zachodnia).
udid	path	True	string	Identyfikator danych użytkownika rejestru danych. Regex pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
api-version	query	True	string	Numer wersji interfejsu API Azure Maps.

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.
Operation-Id		string	Identyfikator operacji w formacie GUID. Regex pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

Treść żądania

Nazwa	Typ	Opis
azureBlob	AzureBlob	Szczegóły rejestru danych obiektów blob platformy Azure.
description	string	Opis podany w rejestrze danych. Maksymalna długość to 1024 znaki.
kind	DataRegistryKind	Rodzaj rejestru danych.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DataRegistry	Zastępowanie zasobu: żądanie zostało zaakceptowane do przetwarzania. Headers Operation-Id: string Operation-Location: string
201 Created	DataRegistry	Tworzenie zasobów: żądanie zostało zaakceptowane do przetwarzania. Headers Operation-Id: string Operation-Location: string
Other Status Codes	MapsErrorResponse	Wystąpił nieoczekiwany błąd. Headers x-ms-error-code: string

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 tworzenia zasobu 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.

Za pomocą tego klucza każda aplikacja jest autoryzowana do uzyskiwania dostępu do wszystkich interfejsów API REST. Innymi słowy, mogą one być obecnie traktowane jako klucze główne dla konta, dla którego są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie dostępu serwer-serwer Azure Maps interfejsów API REST, w których ten klucz może być bezpiecznie przechowywany.

Type: apiKey
In: header

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

Register or replace a udid

Sample Request

HTTP

PUT https://us.atlas.microsoft.com/dataRegistries/29a92cab-74af-49e7-a326-66898220aa9d?api-version=2023-06-01

{
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json"
  }
}

Sample Response

Status code:

201

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

Response Body

{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json",
    "sizeInBytes": 1339
  },
  "status": "Running"
}

Status code:

200

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

Response Body

{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "description": "Contoso Geofence GeoJSON",
  "kind": "AzureBlob",
  "azureBlob": {
    "dataFormat": "geojson",
    "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
    "linkedResource": "my-storage-account",
    "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json",
    "sizeInBytes": 1339
  },
  "status": "Running"
}

Definicje

Nazwa	Opis
AzureBlob	Szczegóły rejestru danych obiektów blob platformy Azure.
DataFormat	Format danych przekazanej zawartości używanej do celów walidacji.
DataRegistry	Rejestr danych w Azure Maps.
DataRegistryKind	Rodzaj rejestru danych.
LongRunningOperationStatus	Stan długotrwałej operacji.
MapsErrorDetail	Szczegóły błędu.
MapsErrorResponse	Typowa odpowiedź na błędy dla interfejsów API Azure Maps zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem.
MapsInnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

AzureBlob

Szczegóły rejestru danych obiektów blob platformy Azure.

Nazwa	Typ	Opis
blobUrl	string	Adres URL obiektu blob zawiera ścieżkę do zarejestrowanego pliku.
contentMD5	string	Zawartość MD5 zawartości używana do walidacji danych.
dataFormat	DataFormat	Format danych przekazanej zawartości używanej do celów walidacji.
linkedResource	string	Identyfikator magazynu danych na koncie Azure Maps.
msiClientId	string	Identyfikator klienta tożsamości zarządzanej przypisanej przez użytkownika. Użyj tożsamości zarządzanej przypisanej przez system, jeśli nie zostanie podana.
sizeInBytes	integer	Rozmiar zawartości w bajtach.

DataFormat

Format danych przekazanej zawartości używanej do celów walidacji.

Nazwa	Typ	Opis
geojson	string	GeoJSON to format wymiany danych geoprzestrzennych oparty na formacie JSON.
zip	string	Format skompresowanych danych.

DataRegistry

Rejestr danych w Azure Maps.

Nazwa	Typ	Opis
azureBlob	AzureBlob	Szczegóły rejestru danych obiektów blob platformy Azure.
description	string	Opis podany w rejestrze danych. Maksymalna długość to 1024 znaki.
error	MapsErrorDetail	Szczegóły błędu.
kind	DataRegistryKind	Rodzaj rejestru danych.
status	LongRunningOperationStatus	Stan długotrwałej operacji.
udid	string	Identyfikator danych użytkownika dla rejestru danych.

DataRegistryKind

Rodzaj rejestru danych.

Nazwa	Typ	Opis
AzureBlob	string	Obiekt bob Azure

LongRunningOperationStatus

Stan długotrwałej operacji.

Nazwa	Typ	Opis
Completed	string	Żądanie zostało ukończone pomyślnie.
Failed	string	Żądanie ma co najmniej jeden błąd.
Running	string	Żądanie jest obecnie przetwarzane.

MapsErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	MapsErrorDetail[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	MapsInnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

MapsErrorResponse

Typowa odpowiedź na błędy dla interfejsów API Azure Maps zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem.

Nazwa	Typ	Opis
error	MapsErrorDetail	Szczegóły błędu.

MapsInnerError

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	MapsInnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.