Spatial - Post Buffer

Referens

Tjänst:: Maps

API-version:: 2022-08-01

Använd för att hämta en FeatureCollection där varje funktion är en buffert runt motsvarande indexerade funktion för indata.

API:et Post Buffer är en HTTP-begäran POST som returnerar en FeatureCollection där varje funktion är en buffert runt motsvarande indexerade funktion för indata. Bufferten kan vara antingen på utsidan eller insidan av den tillhandahållna funktionen, beroende på avståndet som anges i indata. Det måste finnas antingen ett avstånd per funktion i FeatureCollection indata, eller om endast ett avstånd anges, tillämpas avståndet på varje funktion i samlingen. Den positiva (eller negativa) bufferten för en geometri definieras som minkowskisumman (eller skillnaden) i geometrin med en radiecirkel som är lika med buffertavståndets absoluta värde. Buffert-API:et returnerar alltid ett polygonalt resultat. Den negativa bufferten eller nollavståndsbufferten för linjer och punkter är alltid en tom polygon. Indata kan innehålla en samling Point, MultiPoint, Polygon, MultiPolygon, LineString och MultiLineString. GeometryCollection ignoreras om det tillhandahålls.

POST https://{geography}.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
format	path	True	JsonFormat	Önskat format för svaret. Endast `json` format stöds.
geography	path	True	string	Plats för Azure Maps-kontot. Giltiga värden är vi (USA, östra; USA, västra centrala, USA, västra 2) och eu (Europa, norra; Europa, västra). Den här parametern krävs när en `udid` anges i begäran. Om Azure Maps-kontot till exempel finns i USA, östra accepteras endast begäranden till geografin.
api-version	query	True	string	Versionsnummer för Azure Maps API.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID-säkerhetsmodellen. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar .

Begärandetext

Name	Typ	Description
distances	number[]	Lista över avstånden för att beräkna bufferten för, en-till-en per funktion i samlingen eller en för alla funktioner i samlingen.
geometries	GeoJsonFeatureCollection	En giltig `GeoJSON FeatureCollection` objekttyp. Mer information finns i RFC 7946 .

Svar

Name	Typ	Description
200 OK	BufferResult	OK
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till REST-API:er för Azure Maps. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Rest-API:er för Azure Maps.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.

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

Det här är en delad nyckel som etableras när du skapar en Azure Maps-resurs via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de har utfärdats för.

För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst för Rest-API:er för Azure Maps där den här nyckeln kan lagras på ett säkert sätt.

Typ: apiKey
I: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden List SAS på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

PostBuffer

Sample request

HTTP

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

Status code:: 200

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

Definitioner

Name	Description
BufferRequestBody	Ett objekt med en FeatureCollection och en lista över avstånd. Alla egenskaper för funktionen ska innehålla `geometryId`, som används för att identifiera geometrin och är skiftlägeskänslig.
BufferResult	Det här objektet returneras från ett lyckat Spatial Buffer-anrop.
BufferSummary
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
GeoJsonFeature	En giltig `GeoJSON Feature` objekttyp. Mer information finns i RFC 7946 .
GeoJsonFeatureCollection	En giltig `GeoJSON FeatureCollection` objekttyp. Mer information finns i RFC 7946 .
GeoJsonGeometry	Ett giltigt `GeoJSON` geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946 .
GeoJsonGeometryCollection	En giltig `GeoJSON GeometryCollection` objekttyp. Mer information finns i RFC 7946 .
GeoJsonLineString	En giltig `GeoJSON LineString` geometrityp. Mer information finns i RFC 7946 .
GeoJsonMultiLineString	En giltig `GeoJSON MultiLineString` geometrityp. Mer information finns i RFC 7946 .
GeoJsonMultiPoint	En giltig `GeoJSON MultiPoint` geometrityp. Mer information finns i RFC 7946 .
GeoJsonMultiPolygon	En giltig `GeoJSON MultiPolygon` objekttyp. Mer information finns i RFC 7946 .
GeoJsonPoint	En giltig `GeoJSON Point` geometrityp. Mer information finns i RFC 7946 .
GeoJsonPolygon	En giltig `GeoJSON Polygon` geometrityp. Mer information finns i RFC 7946 .
JsonFormat	Önskat format för svaret. Endast `json` format stöds.

BufferRequestBody

Ett objekt med en FeatureCollection och en lista över avstånd. Alla egenskaper för funktionen ska innehålla geometryId, som används för att identifiera geometrin och är skiftlägeskänslig.

Name	Typ	Description
distances	number[]	Lista över avstånden för att beräkna bufferten för, en-till-en per funktion i samlingen eller en för alla funktioner i samlingen.
geometries	GeoJsonFeatureCollection	En giltig `GeoJSON FeatureCollection` objekttyp. Mer information finns i RFC 7946 .

BufferResult

Det här objektet returneras från ett lyckat Spatial Buffer-anrop.

Name	Typ	Description
result	GeoJsonFeatureCollection	FeatureCollection för buffertar för indata.
summary	BufferSummary

BufferSummary

Name	Typ	Description
information	string	Information om vad som hände under samtalet.
udid	string	Udid för användardata om det finns något

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

GeoJsonFeature

En giltig GeoJSON Feature objekttyp. Mer information finns i RFC 7946 .

Name	Typ	Description
featureType	string	Funktionens typ. Värdet beror på vilken datamodell som den aktuella funktionen ingår i. Vissa datamodeller kan ha ett tomt värde.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Ett giltigt `GeoJSON` geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946 .
id	string	Identifierare för funktionen.
type	string: Feature	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonFeatureCollection

En giltig GeoJSON FeatureCollection objekttyp. Mer information finns i RFC 7946 .

Name	Typ	Description
features	GeoJsonFeature[]	Innehåller en lista över giltiga `GeoJSON Feature` objekt.
type	string: FeatureCollection	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonGeometry

Ett giltigt GeoJSON geometriobjekt. Typen måste vara en av de sju giltiga GeoJSON-geometrityperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon och GeometryCollection. Mer information finns i RFC 7946 .

Name	Typ	Description
type	GeoJsonObjectType	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonGeometryCollection

En giltig GeoJSON GeometryCollection objekttyp. Mer information finns i RFC 7946 .

Name	Typ	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Innehåller en lista över giltiga `GeoJSON` geometriobjekt. Observera att koordinaterna i GeoJSON är i x, y-ordning (longitud, latitud).
type	string: GeometryCollection	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonLineString

En giltig GeoJSON LineString geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Koordinater för `GeoJson LineString` geometrin.
type	string: LineString	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiLineString

En giltig GeoJSON MultiLineString geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Koordinater för `GeoJson MultiLineString` geometrin.
type	string: MultiLineString	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiPoint

En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Koordinater för `GeoJson MultiPoint` geometrin.
type	string: MultiPoint	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonMultiPolygon

En giltig GeoJSON MultiPolygon objekttyp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Innehåller en lista över giltiga `GeoJSON Polygon` objekt. Observera att koordinaterna i GeoJSON är i x, y-ordning (longitud, latitud).
type	string: MultiPolygon	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonPoint

En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	A `Position` är en matris med tal med två eller flera element. De två första elementen är longitud och latitud, exakt i den ordningen. Höjd/höjd är ett valfritt tredje element. Mer information finns i RFC 7946 .
type	string: Point	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

GeoJsonPolygon

En giltig GeoJSON Polygon geometrityp. Mer information finns i RFC 7946 .

Name	Typ	Description
coordinates	number[]	Koordinater för `GeoJson Polygon` geometritypen.
type	string: Polygon	Anger `GeoJSON` typen . Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

JsonFormat

Önskat format för svaret. Endast json format stöds.

Name	Typ	Description
json	string	Datautbytesformat för JavaScript-objektnotation

Dela via