Data - Upload

Reference

Služba:: Maps

Verze rozhraní API:: 2.0

Slouží k nahrání datového obsahu do účtu Azure Maps.

Poznámka

Vyřazení datové služby Azure Maps z provozu

Datová služba Azure Maps ( v1 i v2) je nyní zastaralá a 16. 9. 24. bude vyřazena. Aby nedocházelo k přerušení služeb, bude potřeba do 16. 9. do 24. 9. aktualizovat všechna volání datové služby tak, aby používala službu Azure Maps Data Registry . Další informace najdete v tématu Vytvoření registru dat.

Rozhraní Data Upload API je požadavek HTTP POST , který umožňuje volajícímu nahrát datový obsah do služby Azure Maps. Toto rozhraní API můžete použít ve scénáři, jako je nahrání kolekce geofences ve GeoJSONformátu, pro použití v naší službě Geofencing Služby Azure Maps.

Důležité

Používáním této funkce vyjadřujete souhlas s právními podmínkami verze Preview. Další podrobnosti najdete v dodatečných podmínkách verze Preview .

Odeslat žádost o nahrání

K nahrání obsahu použijete POST žádost. Text požadavku bude obsahovat data k nahrání. Parametr dataFormat dotazu bude obsahovat formát pro data, dataSharingLevel parametr dotazu může obsahovat úroveň sdílení dat. Hlavička Content-Type bude nastavena na typ obsahu dat.

Pokud chcete například nahrát kolekci geografických fence ve GeoJSON formátu, nastavte text požadavku na obsah geografické zóny. dataFormat Nastavte parametr dotazu na geojson a hlavičku Content-Type nastavte na jeden z následujících typů médií:

application/json
application/vnd.geo+json
application/octet-stream

Tady je ukázkový text požadavku pro nahrání jednoduché geografické zóny reprezentované geometrií kruhu pomocí středového bodu a poloměru. Následující ukázka je v GeoJSONsouboru :

{
    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-122.126986, 47.639754]
        },
        "properties": {
            "geometryId": "001",
            "radius": 500
        }
    }]
}

Rozhraní API pro nahrávání dat provádí dlouhotrvající operaci.

Limity nahrávání dat

Mějte na paměti, že v současné době má každý účet Azure Maps limit úložiště dat. Jakmile dosáhnete limitu úložiště, všechna nová volání rozhraní API pro nahrávání vrátí chybovou 409 Conflict odpověď HTTP. Kdykoli můžete použít rozhraní API pro odstranění dat k odstranění starého nebo nepoužívaného obsahu a vytvoření místa pro nové nahrání.

POST https://{geography}.atlas.microsoft.com/mapData?api-version=2.0&dataFormat={dataFormat}

S volitelnými parametry:

POST https://{geography}.atlas.microsoft.com/mapData?api-version=2.0&description={description}&dataFormat={dataFormat}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
geography	path	True	string	Tento parametr určuje, kde se nachází prostředek Azure Maps Creator. Platné hodnoty jsou my a eu.
api-version	query	True	string	Číslo verze rozhraní API služby Azure Maps
dataFormat	query	True	DataFormat	Datový formát nahrávaného obsahu.
description	query		string	Popis, který se má dát k nahrání.

Hlavička požadavku

Media Types: "application/json", "application/octet-stream"

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 .

Text požadavku

Media Types: "application/json", "application/octet-stream"

Name	Typ	Description
UploadContent	object	Obsah, který se má nahrát.

Odpovědi

Name	Typ	Description
200 OK	LongRunningOperationResult	Operace je spuštěná nebo dokončená. Pokud byla operace úspěšná, použijte k získání cesty k výsledku hlavičku Resource-Location. Hlavičky Resource-Location: string
202 Accepted		Žádost byla přijata: Žádost byla přijata ke zpracování. K získání stavu použijte adresu URL v hlavičce Operation-Location. Hlavičky Operation-Location: string
Other Status Codes	ErrorResponse	U účtu Azure Maps je dosaženo limitu úložiště dat . Kdykoli můžete použít rozhraní API pro odstranění dat k odstranění starého nebo nepoužívaného obsahu a vytvoření místa pro nové nahrání.
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

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
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řídí při vytvoření účtu Azure Maps na webu Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme použít pro přístup k rozhraním REST API služby Azure Maps přístup k důvěrným klientským aplikacím , aby se váš klíč mohl bezpečně uložit.

Typ: apiKey
V: query

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

Upload GeoJSON data containing geometries that represent a collection of geofences

Sample request

HTTP

POST https://us.atlas.microsoft.com/mapData?api-version=2.0&dataFormat=geojson

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.126986,
          47.639754
        ]
      },
      "properties": {
        "geometryId": "001",
        "radius": 500
      }
    }
  ]
}

Sample response

Status code:: 200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/mapData/operations/{udid}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

Status code:: 409

{
  "error": {
    "code": "409 Conflict",
    "message": "The data storage limit is reached on the Azure Maps account. You can always use the Data Delete API to delete old/unused content and create space for new uploads."
  }
}

Definice

Name	Description
DataFormat	Formát dat nahraného obsahu.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Odpověď na chybu
LongRunningOperationResult	Model odpovědí pro rozhraní API Long-Running Operations.
LroStatus	Stav požadavku.

DataFormat

Formát dat nahraného obsahu.

Name	Typ	Description
dwgzippackage	string	Balíček ZIP obsahující soubor DWG.
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.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

LongRunningOperationResult

Model odpovědí pro rozhraní API Long-Running Operations.

Name	Typ	Description
created	string	Vytvořené časové razítko.
error	ErrorDetail	Podrobnosti o chybě.
operationId	string	ID této dlouhotrvající operace.
status	LroStatus	Stav požadavku.
warning	ErrorDetail	Podrobnosti o chybě.

LroStatus

Stav požadavku.

Name	Typ	Description
Failed	string	Požadavek má jedno nebo více selhání.
NotStarted	string	Žádost se ještě nezačala zpracovávat.
Running	string	Žádost se začala zpracovávat.
Succeeded	string	Žádost se úspěšně dokončila.

Sdílet prostřednictvím