Data Registry - List

Reference

Service:: Maps

API Version:: 2023-06-01

Slouží k získání seznamu všech registrů dat v účtu Azure Maps.

Rozhraní List API je požadavek HTTP GET , který vrací pole obsahující všechny registry dat dříve zaregistrované pomocí rozhraní API register nebo replace.

Koncový bod služby registru dat je omezen rozsahem na oblast vašeho účtu Azure Maps a není k dispozici pro globální účty Azure Maps.

Odeslat žádost o seznam

Pokud chcete zobrazit seznam všech vašich registrů dat, vytvořte GET požadavek bez dalších parametrů.

Vypsat odpověď

Požadavek List vrátí pole datových registrů ve JSON formátu v textu odpovědi.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
geography	path	True	string	Tento parametr určuje, kde se nachází účet Azure Maps. Platné hodnoty jsou us (USA – východ, USA – středozápad, USA – západ 2) a eu (Severní Evropa, Západní Evropa).
api-version	query	True	string	Číslo verze rozhraní API Azure Maps.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určen pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a dá se načíst z rozhraní API účtu Azure Maps roviny správy. Pokud chcete použít zabezpečení Microsoft Entra ID v Azure Maps pokyny najdete v následujících článcích.

Odpovědi

Name Typ Description

200 OK

Name	Typ	Description
200 OK	DataRegistryList	Požadavek se `List` úspěšně dokončil. Tělo odpovědi obsahuje pole registrů dat.
Other Status Codes	MapsErrorResponse	Došlo k neočekávané chybě. Headers x-ms-error-code: string

DataRegistryList

Požadavek se List úspěšně dokončil. Tělo odpovědi obsahuje pole registrů dat.

Other Status Codes

MapsErrorResponse

Došlo k neočekávané chybě.

Headers

x-ms-error-code: string

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jedná se o sdílený klíč, který se zřizuje při vytváření Azure Maps prostředku prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace oprávnění pro přístup ke všem rozhraním REST API. Jinými slovy, tyto klíče se v současné době dají považovat za hlavní klíče k účtu, pro který jsou vystaveny.

U veřejně vystavených aplikací doporučujeme používat přístup mezi servery Azure Maps rozhraní REST API, ve kterých lze tento klíč bezpečně uložit.

Type: apiKey
In: header

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Type: apiKey
In: header

Příklady

List all previously registered data registries

Sample Request

HTTP

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

Sample Response

Status code:: 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==."
      }
    }
  ]
}

Definice

Name	Description
AzureBlob	Podrobnosti registru dat objektů blob v Azure
DataFormat	Formát dat nahraného obsahu, který se používá pro účely ověření.
DataRegistry	Registr dat v Azure Maps.
DataRegistryKind	Druh registru dat.
DataRegistryList	Model odpovědí pro rozhraní API seznamu dat registru. Vrátí seznam všech dříve registrovaných dat.
LongRunningOperationStatus	Stav dlouhotrvající operace.
MapsErrorDetail	Podrobnosti o chybě.
MapsErrorResponse	Běžná chybová odpověď pro rozhraní API Azure Maps, která vrací podrobnosti o chybě pro neúspěšné operace.
MapsInnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

AzureBlob

Podrobnosti registru dat objektů blob v Azure

Name	Typ	Description
blobUrl	string	Adresa URL objektu blob obsahuje cestu k registrovanému souboru.
contentMD5	string	Obsah MD5 obsahu, který se používá k ověření dat.
dataFormat	DataFormat	Formát dat nahraného obsahu, který se používá pro účely ověření.
linkedResource	string	ID úložiště dat v účtu Azure Maps.
msiClientId	string	ID klienta spravované identity přiřazené uživatelem Pokud není k dispozici, použijte spravovanou identitu přiřazenou systémem.
sizeInBytes	integer	Velikost obsahu v bajtech.

DataFormat

Formát dat nahraného obsahu, který se používá pro účely ověření.

Name	Typ	Description
geojson	string	GeoJSON je formát pro výměnu geoprostorových dat založený na formátu JSON.
zip	string	Komprimovaný formát dat.

DataRegistry

Registr dat v Azure Maps.

Name	Typ	Description
azureBlob	AzureBlob	Podrobnosti registru dat objektů blob v Azure
description	string	Popis zadaný registru dat. Maximální délka je 1024 znaků.
error	MapsErrorDetail	Podrobnosti o chybě.
kind	DataRegistryKind	Druh registru dat.
status	LongRunningOperationStatus	Stav dlouhotrvající operace.
udid	string	ID uživatelských dat pro registr dat.

DataRegistryKind

Druh registru dat.

Name	Typ	Description
AzureBlob	string	Azure Blob