Spatial - Post Buffer
Gebruik om een FeatureCollection
op te halen waarbij elke functie een buffer is rond de bijbehorende geïndexeerde functie van de invoer.
De Post Buffer
API is een HTTP-aanvraag POST
die een FeatureCollection
retourneert waarbij elke functie een buffer is rond de bijbehorende geïndexeerde functie van de invoer. De buffer kan zich aan de buitenkant of de binnenkant van de opgegeven functie bevinden, afhankelijk van de afstand die in de invoer is opgegeven. Er moet één afstand zijn opgegeven per functie in de FeatureCollection
invoer, of als er slechts één afstand wordt opgegeven, wordt die afstand toegepast op elke functie in de verzameling. De positieve (of negatieve) buffer van een geometrie wordt gedefinieerd als de Minkowski-som (of het verschil) van de geometrie met een cirkel van radius die gelijk is aan de absolute waarde van de bufferafstand. De buffer-API retourneert altijd een veelhoekig resultaat. De negatieve of nulafstandbuffer van lijnen en punten is altijd een lege veelhoek. De invoer kan een verzameling punt, MultiPoint, Veelhoek, MultiPolygon, LineString en MultiLineString bevatten. GeometryCollection wordt genegeerd als deze is opgegeven.
POST https://{geography}.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
format
|
path | True |
Gewenste indeling van het antwoord. Alleen |
|
geography
|
path | True |
string |
Locatie van het Azure Maps-account. Geldige waarden zijn us (VS - oost, VS - west-centraal, VS - west 2) en eu (Europa - noord, Europa - west). Deze parameter is vereist wanneer een |
api-version
|
query | True |
string |
Versienummer van Azure Maps API. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp. |
Aanvraagbody
Name | Type | Description |
---|---|---|
distances |
number[] |
Lijst met de afstanden voor het berekenen van de buffer, een-op-een per functie in de verzameling of één voor alle functies in de verzameling. |
geometries |
Een geldig |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Er is een onverwachte fout opgetreden. |
Beveiliging
AADToken
Dit zijn de Microsoft Entra OAuth 2.0-stromen. Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.
Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.
Notities
- Deze beveiligingsdefinitie vereist het gebruik van de
x-ms-client-id
header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.
De Authorization URL
is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties.
* Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
* Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.
- Zie Microsoft identity platform overzicht voor meer informatie over 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
Dit is een gedeelde sleutel die wordt ingericht bij het maken van een Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Met deze sleutel wordt elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze zijn uitgegeven.
Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om server-naar-servertoegang te gebruiken voor Azure Maps REST API's waar deze sleutel veilig kan worden opgeslagen.
Type:
apiKey
In:
header
SAS Token
Dit is een shared access signature-token dat wordt gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle over het verloop, de snelheid en de gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.
Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.
Type:
apiKey
In:
header
Voorbeelden
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
]
]
]
}
}
]
}
}
Definities
Name | Description |
---|---|
Buffer |
Een object met een FeatureCollection en een lijst met afstanden. Alle eigenschappen van de functie moeten bevatten |
Buffer |
Dit object wordt geretourneerd na een geslaagde spatial buffer-aanroep. |
Buffer |
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Geo |
Een geldig |
Json |
Gewenste indeling van het antwoord. Alleen |
BufferRequestBody
Een object met een FeatureCollection en een lijst met afstanden. Alle eigenschappen van de functie moeten bevatten geometryId
, die wordt gebruikt voor het identificeren van de geometrie en hoofdlettergevoelig zijn.
Name | Type | Description |
---|---|---|
distances |
number[] |
Lijst met de afstanden voor het berekenen van de buffer, een-op-een per functie in de verzameling of één voor alle functies in de verzameling. |
geometries |
Een geldig |
BufferResult
Dit object wordt geretourneerd na een geslaagde spatial buffer-aanroep.
Name | Type | Description |
---|---|---|
result |
De FeatureCollection van buffers voor de invoer. |
|
summary |
BufferSummary
Name | Type | Description |
---|---|---|
information |
string |
De informatie over wat er tijdens het gesprek is gebeurd. |
udid |
string |
De udid voor de gebruikersgegevens, indien aanwezig |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
Name | Type | Description |
---|---|---|
info |
object |
De aanvullende informatie. |
type |
string |
Het type aanvullende informatie. |
ErrorDetail
De foutdetails.
Name | Type | Description |
---|---|---|
additionalInfo |
Aanvullende informatie over de fout. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
GeoJsonFeature
Een geldig GeoJSON Feature
objecttype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
featureType |
string |
Het type functie. De waarde is afhankelijk van het gegevensmodel waarvan de huidige functie deel uitmaakt. Sommige gegevensmodellen hebben mogelijk een lege waarde. |
geometry | GeoJsonGeometry: |
Een geldig |
id |
string |
Id voor de functie. |
type |
string:
Feature |
Hiermee geeft u het |
GeoJsonFeatureCollection
Een geldig GeoJSON FeatureCollection
objecttype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
features |
Bevat een lijst met geldige |
|
type |
string:
Feature |
Hiermee geeft u het |
GeoJsonGeometry
Een geldig GeoJSON
geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
type |
Geo |
Hiermee geeft u het |
GeoJsonGeometryCollection
Een geldig GeoJSON GeometryCollection
objecttype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Bevat een lijst met geldige |
type |
string:
Geometry |
Hiermee geeft u het |
GeoJsonLineString
Een geldig GeoJSON LineString
geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
coordinates |
number[] |
Coördinaten voor de |
type |
string:
Line |
Hiermee geeft u het |
GeoJsonMultiLineString
Een geldig GeoJSON MultiLineString
geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
coordinates |
number[] |
Coördinaten voor de |
type |
string:
Multi |
Hiermee geeft u het |
GeoJsonMultiPoint
Een geldig GeoJSON MultiPoint
geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
coordinates |
number[] |
Coördinaten voor de |
type |
string:
Multi |
Hiermee geeft u het |
GeoJsonMultiPolygon
Een geldig GeoJSON MultiPolygon
objecttype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
coordinates |
number[] |
Bevat een lijst met geldige |
type |
string:
Multi |
Hiermee geeft u het |
GeoJsonPoint
Een geldig GeoJSON Point
geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
coordinates |
number[] |
A |
type |
string:
Point |
Hiermee geeft u het |
GeoJsonPolygon
Een geldig GeoJSON Polygon
geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Name | Type | Description |
---|---|---|
coordinates |
number[] |
Coördinaten voor het |
type |
string:
Polygon |
Hiermee geeft u het |
JsonFormat
Gewenste indeling van het antwoord. Alleen json
de indeling wordt ondersteund.
Name | Type | Description |
---|---|---|
json |
string |