Data Registry - Register Or Replace

Referencia

Service:: Maps

API Version:: 2023-06-01

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

Az Register API egy HTTP-kérésPUT, amellyel egy Azure Storage-fiókban regisztrálhatja az adatokat egy Azure Maps-fiókkal. A maximális regisztrálható fájlméret egy gigabájt.

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

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

Regisztrálási vagy cserekérés elküldése

A Register és Replace a kérés hosszú ideig futó művelet, amely egy AzureBlob JSON-objektumot tartalmaz az adatregisztrációs adatbázis adatait meghatározó kérés törzsében.

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ó a Azure Maps-fiók. Az érvényes értékek az USA keleti régiója, az USA nyugati középső régiója, az 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. 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	A Azure Maps API verziószáma.

geography

path

True

string

Ez a paraméter határozza meg, hogy hol található a Azure Maps-fiók. Az érvényes értékek az USA keleti régiója, az USA nyugati középső régiója, az 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.

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

A 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 a Microsoft Entra ID biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeletisík Fiók API-jából. A Microsoft Entra ID biztonság Azure Maps az alábbi cikkekben talál útmutatást.
Operation-Id		string	A művelet azonosítója GUID formátumban. 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}$`

string

Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeletisík Fiók API-jából. A Microsoft Entra ID biztonság Azure Maps az alábbi cikkekben talál útmutatást.

Operation-Id

string

A művelet azonosítója GUID formátumban.

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

Kérelem törzse

Name	Típus	Description
azureBlob	AzureBlob	Az Azure Blob Data Registry részletei.
description	string	Az adatregisztrációs adatbázisnak 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. Headers Operation-Id: string Operation-Location: string
201 Created	DataRegistry	Erőforrás létrehozása: A kérelem feldolgozásra elfogadva. Headers Operation-Id: string Operation-Location: string
Other Status Codes	MapsErrorResponse	Váratlan hiba történt. Headers x-ms-error-code: string

Name

Típus

Description

200 OK

DataRegistry

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

Headers

Operation-Id: string
Operation-Location: string

201 Created

DataRegistry

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

Headers

Operation-Id: string
Operation-Location: string

Other Status Codes

MapsErrorResponse

Váratlan hiba történt.

Headers

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 Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. 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 rest API-Azure Maps 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ás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Jegyzetek

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

A Authorization URL az Azure nyilvános felhőpéldányára vonatkozik. 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ése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi az alkalmazások konfigurációalapú beállítását több használati esetben.

A Microsoft Identitásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintése.

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

Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps-erőforrást hoz létre az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

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

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy olyan 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ó.

Type: apiKey
In: header

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre az Azure Maps erőforráson keresztül az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.

Type: apiKey
In: header

Példák

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

Definíciók

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

AzureBlob

Az Azure Blob Data Registry részletei.

Name	Típus	Description
blobUrl	string	A blob URL-címe tartalmazza a regisztrálandó 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él-azonosí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

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

Name	Típus	Description
azureBlob	AzureBlob	Az Azure Blob Data Registry részletei.
description	string	Az adatregisztrációs adatbázisnak 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	Egy 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

Egy hosszú ideig futó művelet állapota.

Name	Típus	Description
Completed	string	A kérés sikeresen befejeződött.
Failed	string	A kérelem 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ót tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

MapsErrorResponse

Gyakori hibaválasz Azure Maps API-k esetében 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ót 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ót tartalmaz a hibáról.

Data Registry - Register Or Replace

Regisztrálási vagy cserekérés elküldése

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Biztonság

AADToken

Jegyzetek

Scopes

subscription-key

SAS Token

Példák

Register or replace a udid

Sample Request

Sample Response

Definíciók

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

További források