Data Registry - List

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 2023-06-01

Użyj polecenia , aby uzyskać listę wszystkich rejestrów danych na koncie usługi Azure Maps.

Interfejs List API to żądanie HTTP GET , które zwraca tablicę zawierającą wszystkie rejestry danych wcześniej zarejestrowane przy użyciu interfejsu API Register lub Replace.

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

Prześlij żądanie listy

Aby wyświetlić listę wszystkich rejestrów danych, wydaj GET żądanie bez dodatkowych parametrów.

Odpowiedź na listę

List Żądanie zwraca tablicę rejestrów danych w JSON formacie w treści odpowiedzi.

GET https://{geography}.atlas.microsoft.com/dataRegistries?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 usługi Azure Maps. Prawidłowe wartości to nas (Wschodnie stany USA, Zachodnie stany USA, Zachodnie stany USA 2) i eu (Europa Północna, Europa Zachodnia).
api-version	query	True	string	Numer wersji interfejsu API usługi 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ń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń microsoft Entra ID w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

Nazwa Typ Opis

200 OK

Nazwa	Typ	Opis
200 OK	DataRegistryList	`List` Żądanie zostało ukończone pomyślnie. Treść odpowiedzi zawiera tablicę rejestrów danych.
Other Status Codes	MapsErrorResponse	Wystąpił nieoczekiwany błąd. Nagłówki x-ms-error-code: string

DataRegistryList

List Żądanie zostało ukończone pomyślnie. Treść odpowiedzi zawiera tablicę rejestrów danych.

Other Status Codes

MapsErrorResponse

Wystąpił nieoczekiwany błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

AADToken

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

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

Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Omówienie platformy tożsamości firmy Microsoft.

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 zasobu usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu 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 do konta, dla którego są wystawiane.

W przypadku publicznie uwidocznionych aplikacji naszym zaleceniem jest użycie dostępu serwera do serwera interfejsów API REST usługi Azure Maps, w których ten klucz może być bezpiecznie przechowywany.

Typ: apiKey
W: header

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny 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

List all previously registered data registries

Przykładowe żądanie

HTTP

GET https://us.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "description": "Contoso Indoor Design",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "zip",
        "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path1.zip",
        "sizeInBytes": 29920,
        "contentMD5": "CsFxZ2YSfxw3cRPlqokV0w=="
      },
      "status": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "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/path2.geojson",
        "sizeInBytes": 1339
      },
      "status": "Running"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "description": "Contoso Geofence GeoJSON",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "geojson",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path3.geojson",
        "sizeInBytes": 1650,
        "contentMD5": "rYpEfIeLbWZPyaICGEGy3A=="
      },
      "status": "Failed",
      "error": {
        "code": "ContentMD5Mismatch",
        "message": "Actual content MD5: sOJMJvFParkSxBsvvrPOMQ== doesn't match expected content MD5: CsFxZ2YSfxw3cRPlqokV0w==."
      }
    }
  ]
}

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 usłudze Azure Maps.
DataRegistryKind	Rodzaj rejestru danych.
DataRegistryList	Model odpowiedzi dla interfejsu API listy rejestrów danych. Zwraca listę wszystkich wcześniej zarejestrowanych danych.
LongRunningOperationStatus	Stan długotrwałej operacji.
MapsErrorDetail	Szczegóły błędu.
MapsErrorResponse	Typowa odpowiedź na błędy interfejsów API usługi Azure Maps w celu zwrócenia szczegółów 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 usługi Azure Maps.
msiClientId	string	Identyfikator klienta tożsamości zarządzanej przypisanej przez użytkownika. Jeśli nie podano tożsamości zarządzanej przypisanej przez system, należy użyć.
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	Skompresowany format danych.

DataRegistry

Rejestr danych w usłudze 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