Spatial - Post Buffer

  • Ссылка
Service:
Maps
API Version:
2022-08-01

Используйте для получения , FeatureCollection где каждый компонент является буфером вокруг соответствующего индексированного признака входных данных.

Post Buffer API — это HTTP-запросPOST, возвращающий FeatureCollection , где каждый компонент представляет собой буфер вокруг соответствующего индексированного компонента входных данных. Буфер может находиться на внешней или внутренней стороне предоставленного компонента в зависимости от расстояния, предоставленного во входных данных. Для каждого компонента во FeatureCollection входных данных должно быть указано одно расстояние, или если указано только одно расстояние, то это расстояние применяется к каждому признаку в коллекции. Положительный (или отрицательный) буфер геометрии определяется как сумма (или разница) минковски геометрии с кругом радиуса, равным абсолютному значению расстояния буфера. API буфера всегда возвращает многоугольный результат. Буфер отрицательного или нулевого расстояния для линий и точек всегда является пустым многоугольником. Входные данные могут содержать коллекцию Point, MultiPoint, Polygon, MultiPolygon, LineString и MultiLineString. GeometryCollection будет игнорироваться, если он указан.

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

Параметры URI

Имя В Обязательно Тип Описание
format
 path True

JsonFormat

Требуемый формат ответа. Поддерживается только формат json.
geography
 path True

string

Расположение учетной записи Azure Maps. Допустимые значения: us (восточная часть США, центрально-западная часть США, западная часть США 2) и eu (Северная Европа, Западная Европа). Этот параметр является обязательным при udid указании в запросе . Например, если учетная запись Azure Maps находится в восточной части США, будут приняты только запросы к географическому региону.
api-version
 query True

string

Номер версии API Azure Maps

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-client-id

string

Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Текст запроса

Имя Тип Описание
distances

number[]

Список расстояний для вычисления буфера, один к одному для каждого компонента в коллекции или по одному для всех компонентов в коллекции.
geometries

GeoJsonFeatureCollection

Допустимый GeoJSON FeatureCollection тип объекта. Дополнительные сведения см. в документе RFC 7946 .

Ответы

Имя Тип Описание
200 OK

BufferResult

ОК
Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

Безопасность

AADToken

Это Microsoft Entra потоков OAuth 2.0. При связывании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений на Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечания

  • Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

Объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

  • Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя Описание
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при создании ресурса Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого ключа любое приложение авторизовано для доступа ко всем REST API. Другими словами, в настоящее время они могут рассматриваться как master ключи к учетной записи, для которой они выданы.

Для общедоступных приложений мы рекомендуем использовать доступ между серверами Azure Maps REST API, где этот ключ можно безопасно хранить.

Type: apiKey
In: header

SAS Token

Это маркер подписанного URL-адреса, созданный с помощью операции List SAS для ресурса Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов, используемых для конкретного маркера. Другими словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи map , чтобы ограничить использование маркера SAS и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

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

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

Определения

Имя Описание
BufferRequestBody

Объект с FeatureCollection и списком расстояний. Все свойства компонента должны содержать geometryId, который используется для идентификации геометрии и учитывает регистр.
BufferResult

Этот объект возвращается из успешного вызова пространственного буфера.
BufferSummary
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Сообщение об ошибке
GeoJsonFeature

Допустимый GeoJSON Feature тип объекта. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonFeatureCollection

Допустимый GeoJSON FeatureCollection тип объекта. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonGeometry

Допустимый GeoJSON объект geometry. Тип должен быть одним из семи допустимых геометрических типов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonGeometryCollection

Допустимый GeoJSON GeometryCollection тип объекта. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonLineString

Допустимый GeoJSON LineString тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonMultiLineString

Допустимый GeoJSON MultiLineString тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonMultiPoint

Допустимый GeoJSON MultiPoint тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonMultiPolygon

Допустимый GeoJSON MultiPolygon тип объекта. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonPoint

Допустимый GeoJSON Point тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
GeoJsonPolygon

Допустимый GeoJSON Polygon тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
JsonFormat

Требуемый формат ответа. Поддерживается только формат json.

BufferRequestBody

Объект с FeatureCollection и списком расстояний. Все свойства компонента должны содержать geometryId, который используется для идентификации геометрии и учитывает регистр.

Имя Тип Описание
distances

number[]

Список расстояний для вычисления буфера, один к одному для каждого компонента в коллекции или по одному для всех компонентов в коллекции.
geometries

GeoJsonFeatureCollection

Допустимый GeoJSON FeatureCollection тип объекта. Дополнительные сведения см. в документе RFC 7946 .

BufferResult

Этот объект возвращается из успешного вызова пространственного буфера.

Имя Тип Описание
result

GeoJsonFeatureCollection

FeatureCollection буферов для входных данных.
summary

BufferSummary

BufferSummary

Имя Тип Описание
information

string

Сведения о том, что произошло во время вызова.
udid

string

udid для пользовательских данных, если он существует

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

GeoJsonFeature

Допустимый GeoJSON Feature тип объекта. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
featureType

string

Тип функции. Значение зависит от модели данных, частью этой функции является текущий компонент. Некоторые модели данных могут иметь пустое значение.
geometry GeoJsonGeometry:

Допустимый GeoJSON объект geometry. Тип должен быть одним из семи допустимых геометрических типов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в документе RFC 7946 .
id

string

Идентификатор компонента.
type string:

Feature

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonFeatureCollection

Допустимый GeoJSON FeatureCollection тип объекта. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
features

GeoJsonFeature[]

Содержит список допустимых GeoJSON Feature объектов.
type string:

FeatureCollection

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonGeometry

Допустимый GeoJSON объект geometry. Тип должен быть одним из семи допустимых геометрических типов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
type

GeoJsonObjectType

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonGeometryCollection

Допустимый GeoJSON GeometryCollection тип объекта. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
geometries GeoJsonGeometry[]:

Содержит список допустимых GeoJSON объектов geometry. Обратите внимание , что координаты в GeoJSON имеют порядок x, y (долгота, широта).
type string:

GeometryCollection

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonLineString

Допустимый GeoJSON LineString тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
coordinates

number[]

Координаты геометрии GeoJson LineString .
type string:

LineString

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiLineString

Допустимый GeoJSON MultiLineString тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
coordinates

number[]

Координаты геометрии GeoJson MultiLineString .
type string:

MultiLineString

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiPoint

Допустимый GeoJSON MultiPoint тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
coordinates

number[]

Координаты геометрии GeoJson MultiPoint .
type string:

MultiPoint

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiPolygon

Допустимый GeoJSON MultiPolygon тип объекта. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
coordinates

number[]

Содержит список допустимых GeoJSON Polygon объектов. Обратите внимание , что координаты в GeoJSON имеют порядок x, y (долгота, широта).
type string:

MultiPolygon

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonPoint

Допустимый GeoJSON Point тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
coordinates

number[]

— Position это массив чисел с двумя или более элементами. Первые два элемента — долгота и широта, именно в этом порядке. Высота или высота является необязательным третьим элементом. Дополнительные сведения см. в документе RFC 7946 .
type string:

Point

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonPolygon

Допустимый GeoJSON Polygon тип геометрии. Дополнительные сведения см. в документе RFC 7946 .

Имя Тип Описание
coordinates

number[]

Координаты для GeoJson Polygon типа geometry.
type string:

Polygon

Указывает тип элемента GeoJSON. Должен быть одним из девяти допустимых типов объектов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

JsonFormat

Требуемый формат ответа. Поддерживается только формат json.

Имя Тип Описание
json

string

Формат обмена данными нотации объектов JavaScript