Data Registry - Get Data Registry

Reference

Služba:: Maps

Verze rozhraní API:: 2023-06-01

Slouží k získání informací o zadaném registru dat.

Rozhraní Get Data Registry API je požadavek HTTP GET , který v případě úspěchu vrací informace registru dat jako objekt AzureBlob ve formátu JSON v textu odpovědi spolu se stavovým kódem HTTP 200. Pokud Azure Maps nemá přístup k podkladovému obsahu nebo kontrola integrity selže, status nastaví se hodnota na Failed a vrátí se chyba.

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

Odeslání žádosti o získání registru dat

Žádost registru GET dat vrátí podrobnosti požadovaného registru dat podle zadaného udidregistru dat . Podrobnosti se vrátí v textu odpovědi ve formátu JSON.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

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).
udid	path	True	string	ID uživatelských dat registru dat. Vzor regulárního výrazu: `^[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	Číslo verze rozhraní API služby Azure Maps.

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

udid

path

True

string

ID uživatelských dat registru dat.

Vzor regulárního výrazu: ^[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

Číslo verze rozhraní API služby 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 roviny správy Služby Azure Maps. Informace o použití zabezpečení Microsoft Entra ID ve službě Azure Maps najdete v následujících článcích .

Odpovědi

Name Typ Description

200 OK

Name	Typ	Description
200 OK	DataRegistry	Požadavek se `Get Data Registry` úspěšně dokončil. Tělo odpovědi obsahuje registr dat zadaného `udid`objektu .
Other Status Codes	MapsErrorResponse	Došlo k neočekávané chybě. Hlavičky x-ms-error-code: string

DataRegistry

Požadavek se Get Data Registry úspěšně dokončil. Tělo odpovědi obsahuje registr dat zadaného udidobjektu .

Other Status Codes

MapsErrorResponse

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

Hlavičky

x-ms-error-code: string

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra 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 rozhraním REST API služby Azure Maps. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika účtům prostředků nebo dílčím prostředkům Azure Maps. 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 rozhraním REST API služby Azure Maps.

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í prostředku Azure Maps, 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 webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

subscription-key

Toto je sdílený klíč, který se zřizuje při vytváření prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu 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 k rozhraním REST API služby Azure Maps, kde je možné tento klíč bezpečně uložit.

Typ: apiKey
V: header

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v prostředku Azure Maps prostřednictvím roviny správy 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.

Typ: apiKey
V: header

Příklady

Get the data registry of a completed udid

Get the data registry of a failed udid

Get the data registry of a completed udid

Ukázkový požadavek

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Ukázková odpověď

Stavový kód:: 200

{
  "udid": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "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,
    "contentMD5": "sOJMJvFParkSxBsvvrPOMQ=="
  },
  "status": "Completed"
}

Get the data registry of a failed udid

Ukázkový požadavek

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Ukázková odpověď

Stavový kód:: 200

{
  "udid": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "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"
  },
  "status": "Failed",
  "error": {
    "code": "AuthorizationPermissionMismatch",
    "message": "Not authorized to perform this operation on resource: https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json."
  }
}

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.
LongRunningOperationStatus	Stav dlouhotrvající operace.
MapsErrorDetail	Podrobnosti o chybě.
MapsErrorResponse	Běžná chybová odpověď pro rozhraní API služby 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

LongRunningOperationStatus

Stav dlouhotrvající operace.

Name	Typ	Description
Completed	string	Požadavek se úspěšně dokončil.
Failed	string	Požadavek má jedno nebo více selhání.
Running	string	Žádost se právě zpracovává.

MapsErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
code	string	Jeden ze serverem definované sady kódů chyb.
details	MapsErrorDetail[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	MapsInnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

MapsErrorResponse

Běžná chybová odpověď pro rozhraní API služby Azure Maps, která vrací podrobnosti o chybě pro neúspěšné operace.

Name	Typ	Description
error	MapsErrorDetail	Podrobnosti o chybě.

MapsInnerError

Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

Name	Typ	Description
code	string	Kód chyby
innererror	MapsInnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

Sdílet prostřednictvím

Data Registry - Get Data Registry

Odeslání žádosti o získání registru dat

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

AADToken

Poznámky

Rozsahy

subscription-key

SAS Token

Příklady

Get the data registry of a completed udid

Ukázkový požadavek

Ukázková odpověď

Get the data registry of a failed udid

Ukázkový požadavek

Ukázková odpověď

Definice

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Další materiály