Data Registry - Register Or Replace

Referencia

Szolgáltatás:: Maps

API-verzió:: 2023-06-01

Az Azure Storage-fiókban tárolt adatok regisztrálása Azure Maps-fiókkal.

Az Register API egy HTTP-kérés PUT , amellyel az adatok regisztrálva lesznek egy Azure Storage-fiókban egy Azure Maps-fiókkal. A maximálisan regisztrálható fájlméret egy gigabájt.

Ez olyan helyzetekben hasznos, mint egy Geofences-gyűjtemény GeoJSON regisztrálása formátumban az Azure Maps Geofencing Service-ben való használatra, vagy DWG-tervfájlok készletének regisztrálása tömörített rajzcsomagként az Azure Maps Creator Conversion Service-ben való használatra.

Az adatregisztrációs szolgáltatás végpontja az Azure Maps-fiók régiójára korlátozódik, és nem érhető el a globális Azure Maps-fiókokhoz.

Regisztráció elküldése vagy kérés cseréje

A Register és Replace a kérések hosszú ideig futó műveletek, amelyek egy AzureBlob JSON-objektumot tartalmaznak a kérelem törzsében, amely meghatározza az adatregisztrációs adatbázis adatait.

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

URI-paraméterek

Name In Kötelező Típus Description

Name	In	Kötelező	Típus	Description
geography	path	True	string	Ez a paraméter határozza meg, hogy hol található az Azure Maps-fiók. Érvényes értékek: mi (USA keleti régiója, USA nyugati középső régiója, USA 2. nyugati régiója) és az EU (Észak-Európa, Nyugat-Európa).
udid	path	True	string	Az adatregisztrációs adatbázis felhasználói adatazonosítója. Reguláris kifejezési minta: `^[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	Az Azure Maps API verziószáma.

geography

path

True

string

Ez a paraméter határozza meg, hogy hol található az Azure Maps-fiók. Érvényes értékek: mi (USA keleti régiója, USA nyugati középső régiója, USA 2. nyugati régiója) és az EU (Észak-Európa, Nyugat-Európa).

udid

path

True

string

Az adatregisztrációs adatbázis felhasználói adatazonosítója.

Reguláris kifejezési minta: ^[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

Az Azure Maps API verziószáma.

Kérelem fejléce

Name Kötelező Típus Description

x-ms-client-id

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen használatban a Microsoft Entra ID biztonsági modellel együtt. Az Azure Maps-fiók egyedi azonosítóját jelöli, és lekérhető az Azure Maps felügyeleti síkjának Fiók API-jából. A Microsoft Entra ID-biztonság Azure Mapsben való használatához tekintse meg az alábbi cikkeket .
Operation-Id		string	A műveletazonosító GUID formátumban. Reguláris kifejezési minta: `^[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}$`

string

Meghatározza, hogy melyik fiók legyen használatban a Microsoft Entra ID biztonsági modellel együtt. Az Azure Maps-fiók egyedi azonosítóját jelöli, és lekérhető az Azure Maps felügyeleti síkjának Fiók API-jából. A Microsoft Entra ID-biztonság Azure Mapsben való használatához tekintse meg az alábbi cikkeket .

Operation-Id

string

A műveletazonosító GUID formátumban.

Reguláris kifejezési minta: ^[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}$

Kérelem törzse

Name	Típus	Description
azureBlob	AzureBlob	Az Azure Blob Data Registry adatai.
description	string	Az adatjegyzékben megadott leírás. A maximális hossz 1024 karakter.
kind	DataRegistryKind	Adatregisztrációs adatbázis típusa.

Válaszok

Name	Típus	Description
200 OK	DataRegistry	Erőforrás cseréje: A kérelem feldolgozásra elfogadva. Fejlécek Operation-Id: string Operation-Location: string
201 Created	DataRegistry	Erőforrás létrehozása: A kérelem feldolgozásra elfogadva. Fejlécek Operation-Id: string Operation-Location: string
Other Status Codes	MapsErrorResponse	Váratlan hiba történt. Fejlécek x-ms-error-code: string

Name

Típus

Description

200 OK

DataRegistry

Erőforrás cseréje: A kérelem feldolgozásra elfogadva.

Fejlécek

Operation-Id: string
Operation-Location: string

201 Created

DataRegistry

Erőforrás létrehozása: A kérelem feldolgozásra elfogadva.

Fejlécek

Operation-Id: string
Operation-Location: string

Other Status Codes

MapsErrorResponse

Váratlan hiba történt.

Fejlécek

x-ms-error-code: string

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0 folyamatok. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható az Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps-erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel, vagy egy vagy több Azure Maps REST API-ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Jegyzetek

Ez a biztonsági definíció megköveteli a fejléc használatát x-ms-client-id annak jelzéséhez, hogy az alkalmazás melyik Azure Maps-erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.

Ez Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül. * Az Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.

A Microsoft identitásplatformról további információt a Microsoft identitásplatform áttekintése című témakörben talál.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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

subscription-key

Ez egy megosztott kulcs, amely akkor van kiépítve, amikor Azure Maps-erőforrást hoz létre az Azure Felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ezek jelenleg főkulcsként kezelhetők ahhoz a fiókhoz, amelyre ki vannak adva.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy az Azure Maps REST API-k kiszolgálóról kiszolgálóra történő hozzáférését használja, ahol ez a kulcs biztonságosan tárolható.

Típus: apiKey
In: header

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat az Azure Maps-erőforrás Sas listázási műveletéből jön létre az Azure Felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonat lejáratához, sebességéhez és régiójához. Más szóval az SAS-jogkivonattal az alkalmazások biztonságosabb módon szabályozhatják a hozzáférést, mint a megosztott kulcs.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy konfigurálja az engedélyezett források adott listáját a Térképfiók erőforráson a megjelenítési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Típus: apiKey
In: header

Példák

Register or replace a udid

Mintakérelem

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"
  }
}

Mintaválasz

Állapotkód:: 201

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

{
  "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"
}

Állapotkód:: 200

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

{
  "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"
}

Definíciók

Name	Description
AzureBlob	Az Azure Blob Data Registry adatai.
DataFormat	Az érvényesítéshez használt feltöltött tartalom adatformátuma.
DataRegistry	Az Azure Maps adatregisztrációs adatbázisa.
DataRegistryKind	Adatregisztrációs adatbázis típusa.
LongRunningOperationStatus	Hosszú ideig futó művelet állapota.
MapsErrorDetail	A hiba részletei.
MapsErrorResponse	Az Azure Maps API-k gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához.
MapsInnerError	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.

AzureBlob

Az Azure Blob Data Registry adatai.

Name	Típus	Description
blobUrl	string	A blob URL-címe tartalmazza a regisztrált fájl elérési útját.
contentMD5	string	Az adatérvényesítéshez használt tartalom MD5 tartalma.
dataFormat	DataFormat	Az érvényesítéshez használt feltöltött tartalom adatformátuma.
linkedResource	string	Az Azure Maps-fiókban található adattár azonosítója.
msiClientId	string	A felhasználó által hozzárendelt felügyelt identitás ügyfélazonosítója. Ha nincs megadva, használja a rendszer által hozzárendelt felügyelt identitást.
sizeInBytes	integer	A tartalom mérete bájtban.

DataFormat

Az érvényesítéshez használt feltöltött tartalom adatformátuma.

Name	Típus	Description
geojson	string	A GeoJSON egy JSON-alapú térinformatikai adatcsere-formátum.
zip	string	Tömörített adatformátum.

DataRegistry

Az Azure Maps adatregisztrációs adatbázisa.

Name	Típus	Description
azureBlob	AzureBlob	Az Azure Blob Data Registry adatai.
description	string	Az adatjegyzékben megadott leírás. A maximális hossz 1024 karakter.
error	MapsErrorDetail	A hiba részletei.
kind	DataRegistryKind	Adatregisztrációs adatbázis típusa.
status	LongRunningOperationStatus	Hosszú ideig futó művelet állapota.
udid	string	Az adatregisztrációs adatbázis felhasználói adatazonosítója.

DataRegistryKind

Adatregisztrációs adatbázis típusa.

Name	Típus	Description
AzureBlob	string	Azure-blob

LongRunningOperationStatus

Hosszú ideig futó művelet állapota.

Name	Típus	Description
Completed	string	A kérés sikeresen befejeződött.
Failed	string	A kérés egy vagy több hibával rendelkezik.
Running	string	A kérés feldolgozása folyamatban van.

MapsErrorDetail

A hiba részletei.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	MapsErrorDetail[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	MapsInnerError	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

MapsErrorResponse

Az Azure Maps API-k gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához.

Name	Típus	Description
error	MapsErrorDetail	A hiba részletei.

MapsInnerError

Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.

Name	Típus	Description
code	string	A hibakód.
innererror	MapsInnerError	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.

Megosztás a következőn keresztül:

Data Registry - Register Or Replace

Regisztráció elküldése vagy kérés cseréje

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Biztonság

AADToken

Jegyzetek

Hatókörök

subscription-key

SAS Token

Példák

Register or replace a udid

Mintakérelem

Mintaválasz

Definíciók

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

További források