Spatial - Post Buffer
Pomocí můžete zjistit, FeatureCollection
kde každá funkce je vyrovnávací pamětí kolem odpovídající indexované funkce vstupu.
Rozhraní Post Buffer
API je požadavek HTTP POST
, který vrací FeatureCollection
, kde každá funkce je vyrovnávací pamětí kolem odpovídající indexované funkce vstupu. Vyrovnávací paměť může být buď na vnější straně, nebo uvnitř poskytnuté funkce, v závislosti na vzdálenosti zadané ve vstupu. Ve vstupu musí být k dispozici jedna vzdálenost pro každou funkci FeatureCollection
, nebo pokud je zadaná pouze jedna vzdálenost, použije se tato vzdálenost pro všechny součásti v kolekci. Kladný (nebo záporný) vyrovnávací paměť geometrie je definován jako Minkowskiho součet (nebo rozdíl) geometrie s kruhem o poloměru, který se rovná absolutní hodnotě vzdálenosti vyrovnávací paměti. Rozhraní API vyrovnávací paměti vždy vrátí polygonální výsledek. Vyrovnávací paměť řádků a bodů se zápornou nebo nulovou vzdáleností je vždy prázdný mnohoúhelník. Vstup může obsahovat kolekci Point, MultiPoint, Polygon, MultiPolygon, LineString a MultiLineString. GeometryCollection bude ignorován, pokud je poskytnuta.
POST https://{geography}.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
format
|
path | True |
Požadovaný formát odpovědi Podporuje se pouze |
|
geography
|
path | True |
string |
Umístění účtu Azure Maps. Platné hodnoty jsou my (USA – východ, USA – středozápad, USA – západ 2) a eu (Severní Evropa, Západní Evropa). Tento parametr je povinný, pokud |
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 je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích. |
Text požadavku
Name | Typ | Description |
---|---|---|
distances |
number[] |
Seznam vzdáleností pro výpočet vyrovnávací paměti, 1:1 pro každou funkci v kolekci nebo jednu pro všechny funkce v kolekci. |
geometries |
Platný |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Došlo k neočekávané chybě. |
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 složené 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 pro konkrétní rozhraní API a obory.
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. Můžete ho získat z rozhraní MAPS MANAGEMENT API.
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í 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 klíčem má každá aplikace autorizaci pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystavené.
U veřejně vystavených aplikací doporučujeme použít přístup mezi servery Azure Maps rozhraní REST API, kde je možné 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 v 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 tokenem má každá aplikace autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečený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 účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.
Type:
apiKey
In:
header
Příklady
PostBuffer
Sample Request
POST https://us.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01
{
"geometries": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"geometryId": "ExampleId"
},
"geometry": {
"type": "Point",
"coordinates": [
-111.9267386,
33.5362475
]
}
}
]
},
"distances": [
176.3
]
}
Sample Response
{
"summary": {
"udid": null,
"information": "1 feature processed in user data"
},
"result": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"geometryId": "ExampleId",
"bufferDist": 176.3
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-111.92483859605078,
33.5362475
],
[
-111.92487510409389,
33.53587682761772
],
[
-111.92498322523961,
33.535520399967204
],
[
-111.92515880445296,
33.535191914363196
],
[
-111.92539509432322,
33.53490399432323
],
[
-111.92568301436319,
33.53466770445297
],
[
-111.9260114999672,
33.53449212523963
],
[
-111.9263679276177,
33.5343840040939
],
[
-111.9267386,
33.534347496050785
],
[
-111.92710927238228,
33.5343840040939
],
[
-111.92746570003278,
33.53449212523963
],
[
-111.9277941856368,
33.53466770445297
],
[
-111.92808210567676,
33.53490399432323
],
[
-111.92831839554702,
33.535191914363196
],
[
-111.92849397476037,
33.535520399967204
],
[
-111.9286020959061,
33.53587682761772
],
[
-111.92863860394921,
33.5362475
],
[
-111.9286020959061,
33.53661817238228
],
[
-111.92849397476037,
33.5369746000328
],
[
-111.92831839554702,
33.53730308563681
],
[
-111.92808210567676,
33.537591005676774
],
[
-111.9277941856368,
33.53782729554703
],
[
-111.92746570003278,
33.53800287476037
],
[
-111.92710927238228,
33.5381109959061
],
[
-111.9267386,
33.53814750394922
],
[
-111.9263679276177,
33.5381109959061
],
[
-111.9260114999672,
33.53800287476037
],
[
-111.92568301436319,
33.53782729554703
],
[
-111.92539509432322,
33.537591005676774
],
[
-111.92515880445296,
33.53730308563681
],
[
-111.92498322523961,
33.5369746000328
],
[
-111.92487510409389,
33.53661817238228
],
[
-111.92483859605078,
33.5362475
]
]
]
}
}
]
}
}
Definice
Name | Description |
---|---|
Buffer |
Objekt s FeatureCollection a seznam vzdáleností. Všechny vlastnosti prvku by měly obsahovat |
Buffer |
Tento objekt je vrácen z úspěšného volání prostorové vyrovnávací paměti. |
Buffer |
|
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Chybová odpověď |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Json |
Požadovaný formát odpovědi Podporuje se pouze |
BufferRequestBody
Objekt s FeatureCollection a seznam vzdáleností. Všechny vlastnosti prvku by měly obsahovat geometryId
, který slouží k identifikaci geometrie a rozlišuje malá a velká písmena.
Name | Typ | Description |
---|---|---|
distances |
number[] |
Seznam vzdáleností pro výpočet vyrovnávací paměti, 1:1 pro každou funkci v kolekci nebo jednu pro všechny funkce v kolekci. |
geometries |
Platný |
BufferResult
Tento objekt je vrácen z úspěšného volání prostorové vyrovnávací paměti.
Name | Typ | Description |
---|---|---|
result |
FeatureCollection vyrovnávacích pamětí pro vstup. |
|
summary |
BufferSummary
Name | Typ | Description |
---|---|---|
information |
string |
Informace o tom, co se stalo během hovoru. |
udid |
string |
Udid pro uživatelská data, pokud existuje |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
GeoJsonFeature
Platný GeoJSON Feature
typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
featureType |
string |
Typ funkce. Hodnota závisí na datovém modelu, který je součástí aktuální funkce. Některé datové modely můžou mít prázdnou hodnotu. |
geometry | GeoJsonGeometry: |
Platný |
id |
string |
Identifikátor funkce |
type |
string:
Feature |
Určuje |
GeoJsonFeatureCollection
Platný GeoJSON FeatureCollection
typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
features |
Obsahuje seznam platných |
|
type |
string:
Feature |
Určuje |
GeoJsonGeometry
Platný GeoJSON
objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
type |
Geo |
Určuje |
GeoJsonGeometryCollection
Platný GeoJSON GeometryCollection
typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Obsahuje seznam platných |
type |
string:
Geometry |
Určuje |
GeoJsonLineString
Platný GeoJSON LineString
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
|
type |
string:
Line |
Určuje |
GeoJsonMultiLineString
Platný GeoJSON MultiLineString
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
|
type |
string:
Multi |
Určuje |
GeoJsonMultiPoint
Platný GeoJSON MultiPoint
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
|
type |
string:
Multi |
Určuje |
GeoJsonMultiPolygon
Platný GeoJSON MultiPolygon
typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Obsahuje seznam platných |
type |
string:
Multi |
Určuje |
GeoJsonPoint
Platný GeoJSON Point
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
A |
type |
string:
Point |
Určuje |
GeoJsonPolygon
Platný GeoJSON Polygon
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Souřadnice typu |
type |
string:
Polygon |
Určuje |
JsonFormat
Požadovaný formát odpovědi Podporuje se pouze json
formát.
Name | Typ | Description |
---|---|---|
json |
string |