Search - Get Search Polygon

참조

서비스:: Maps

API 버전:: 1.0

도시 또는 국가 지역과 같은 지리적 영역 셰이프의 다각형 데이터를 가져오는 데 사용합니다.

Get Polygon API는 이전에 GeoJSON 형식의 온라인 검색 요청에서 검색된 엔터티 집합에 대한 도시 또는 국가/지역 개요와 같은 기하 도형 데이터를 반환하는 HTTP GET 요청입니다. 기하 도형 ID는 검색 주소 또는 검색 유사 항목 호출에서 "geometry" 및 "id" 아래의 sourceGeometry 개체에 반환됩니다.

온라인 검색 엔드포인트에서 검색된 기하 도형 ID는 수명이 제한되어 있으므로 나중에 조회할 수 있도록 기하 도형 ID를 영구 스토리지에 저장하는 것은 권장되지 않습니다. 다각형 메서드에 대한 요청은 ID를 제공한 온라인 검색 메서드에 대한 요청 후 몇 분 이내에 이루어질 것으로 예상됩니다. 이 서비스는 최대 20개의 식별자를 일괄 처리 요청할 수 있습니다.

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
format	path	True	JsonFormat	원하는 응답 형식입니다. `json` 형식만 지원됩니다.
api-version	query	True	string	Azure Maps API의 버전 번호입니다.
geometries	query	True	string[]	이전에 온라인 검색 요청에서 검색된 쉼표로 구분된 기하 도형 UUID 목록입니다.

요청 헤더

Name	필수	형식	Description
x-ms-client-id		string	Microsoft Entra ID 보안 모델과 함께 사용할 계정을 지정합니다. Azure Maps 계정에 대한 고유 ID를 나타내며 Azure Maps 관리 평면 계정 API에서 검색할 수 있습니다. Azure Maps에서 Microsoft Entra ID 보안을 사용하려면 지침에 대한 다음 문서를 참조하세요.

응답

Name	형식	Description
200 OK	PolygonResult	그래
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 리소스를 나타내야 합니다. 이는 Maps 관리 API에서 가져올 수 있습니다.
Authorization URL Azure 퍼블릭 클라우드 인스턴스와 관련이 있습니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Microsoft Entra ID 구성이 있습니다.
Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면에서 구성됩니다.
Azure Maps Web SDK 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 사용할 수 있습니다.
Microsoft ID 플랫폼에 대한 자세한 내용은 Microsoft ID 플랫폼 개요참조하세요.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Azure Portal에서 Azure Maps 계정 만들거나 PowerShell, CLI, Azure SDK 또는 REST API를 사용할 때 프로비전되는 공유 키입니다.

이 키를 사용하면 모든 애플리케이션이 모든 REST API에 액세스할 수 있습니다. 즉, 이 키를 발급된 계정에서 마스터 키로 사용할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 키를 안전하게 저장할 수 있도록 기밀 클라이언트 애플리케이션 접근 방식을 사용하여 Azure Maps REST API에 액세스하는 것이 좋습니다.

형식: apiKey
In(다음 안에): query

SAS Token

공유 액세스 서명 토큰은 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해 Azure Maps 리소스의 SAS 나열 작업에서 만들어집니다.

이 토큰을 사용하면 모든 애플리케이션이 Azure 역할 기반 액세스 제어를 사용하여 액세스하고 특정 토큰에 사용할 만료, 속도 및 지역에 대한 세분화된 제어 권한을 부여받습니다. 즉, SAS 토큰을 사용하여 애플리케이션이 공유 키보다 더 보안이 유지되는 방식으로 액세스를 제어할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 렌더링 남용을 제한하고 정기적으로 SAS 토큰을 갱신하도록 맵 계정 리소스 허용된 원본의 특정 목록을 구성하는 것이 좋습니다.

형식: apiKey
In(다음 안에): header

예제

Get the Geometry using the geometry id returned by the previous Search

샘플 요청

HTTP

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca

샘플 응답

상태 코드:: 200

{
  "additionalData": [
    {
      "providerID": "1111-2222-32-4444444444444",
      "geometryData": {
        "type": "FeatureCollection",
        "features": [
          {
            "type": "Feature",
            "properties": {},
            "geometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    -122.0665062,
                    47.6496252
                  ],
                  [
                    -122.0664863,
                    47.6496113
                  ],
                  [
                    -122.0664843,
                    47.6496014
                  ],
                  [
                    -122.0663693,
                    47.6495247
                  ],
                  [
                    -122.0663017,
                    47.6494664
                  ],
                  [
                    -122.0662679,
                    47.6494247
                  ],
                  [
                    -122.0661647,
                    47.6493314
                  ],
                  [
                    -122.067177,
                    47.649298
                  ],
                  [
                    -122.090715,
                    47.6543598
                  ],
                  [
                    -122.0907846,
                    47.6542921
                  ],
                  [
                    -122.0908284,
                    47.6542603
                  ]
                ]
              ]
            },
            "id": "1111-2222-32-4444444444444"
          }
        ]
      }
    }
  ]
}

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
GeoJsonFeature	유효한 `GeoJSON Feature` 개체 형식입니다. 자세한 내용은 RFC 7946 참조하세요.
GeoJsonFeatureCollection	유효한 `GeoJSON FeatureCollection` 개체 형식입니다. 자세한 내용은 RFC 7946 참조하세요.
GeoJsonGeometry	유효한 `GeoJSON` 기하 도형 개체입니다. 이 형식은 Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon 및 GeometryCollection의 7가지 유효한 GeoJSON 기하 도형 형식 중 하나여야 합니다. 자세한 내용은 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` 형식만 지원됩니다.
Polygon
PolygonResult	이 개체는 성공적인 검색 다각형 호출에서 반환됩니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

GeoJsonFeature

Object

유효한 GeoJSON Feature 개체 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

Name	형식	Description
featureType	string	기능의 형식입니다. 값은 현재 기능이 속한 데이터 모델에 따라 달라집니다. 일부 데이터 모델에는 빈 값이 있을 수 있습니다.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	유효한 `GeoJSON` 기하 도형 개체입니다. 이 형식은 Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon 및 GeometryCollection의 7가지 유효한 GeoJSON 기하 도형 형식 중 하나여야 합니다. 자세한 내용은 RFC 7946 참조하세요.
id	string	기능에 대한 식별자입니다.
type	string: Feature	`GeoJSON` 형식을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, FeatureCollection 등 유효한 9가지 GeoJSON 개체 형식 중 하나여야 합니다.

GeoJsonFeatureCollection

Object

유효한 GeoJSON FeatureCollection 개체 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

Name	형식	Description
features	GeoJsonFeature[]	유효한 `GeoJSON Feature` 개체 목록을 포함합니다.
type	string: FeatureCollection	`GeoJSON` 형식을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, FeatureCollection 등 유효한 9가지 GeoJSON 개체 형식 중 하나여야 합니다.

GeoJsonGeometry

Object

유효한 GeoJSON 기하 도형 개체입니다. 이 형식은 Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon 및 GeometryCollection의 7가지 유효한 GeoJSON 기하 도형 형식 중 하나여야 합니다. 자세한 내용은 RFC 7946 참조하세요.

Name	형식	Description
type	GeoJsonObjectType	`GeoJSON` 형식을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, FeatureCollection 등 유효한 9가지 GeoJSON 개체 형식 중 하나여야 합니다.

GeoJsonGeometryCollection

Object

유효한 GeoJSON GeometryCollection 개체 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

Name	형식	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	유효한 `GeoJSON` 기하 도형 개체 목록을 포함합니다. GeoJSON의 좌표가 x, y 순서(경도, 위도)인.
type	string: GeometryCollection	`GeoJSON` 형식을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, FeatureCollection 등 유효한 9가지 GeoJSON 개체 형식 중 하나여야 합니다.

GeoJsonLineString

Object

유효한 GeoJSON LineString 기하 도형 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

Name	형식	Description
coordinates	number[] (double)	`GeoJson LineString` 기하 도형의 좌표입니다.
type	string: LineString	`GeoJSON` 형식을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, FeatureCollection 등 유효한 9가지 GeoJSON 개체 형식 중 하나여야 합니다.

GeoJsonMultiLineString

Object

유효한 GeoJSON MultiLineString 기하 도형 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

Name	형식	Description
coordinates	number[] (double)	`GeoJson MultiLineString` 기하 도형의 좌표입니다.
type	string: MultiLineString	`GeoJSON` 형식을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, FeatureCollection 등 유효한 9가지 GeoJSON 개체 형식 중 하나여야 합니다.

GeoJsonMultiPoint

Object

유효한 GeoJSON MultiPoint 기하 도형 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

Name	형식	Description
coordinates	number[] (double)	`GeoJson MultiPoint` 기하 도형의 좌표입니다.
type	string: MultiPoint	`GeoJSON` 형식을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, FeatureCollection 등 유효한 9가지 GeoJSON 개체 형식 중 하나여야 합니다.

GeoJsonMultiPolygon

Object

유효한 GeoJSON MultiPolygon 개체 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

Name	형식	Description
coordinates	number[] (double)	유효한 `GeoJSON Polygon` 개체 목록을 포함합니다. GeoJSON의 좌표가 x, y 순서(경도, 위도)인.
type	string: MultiPolygon	`GeoJSON` 형식을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, FeatureCollection 등 유효한 9가지 GeoJSON 개체 형식 중 하나여야 합니다.

GeoJsonPoint

Object

유효한 GeoJSON Point 기하 도형 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

Name	형식	Description
coordinates	number[] (double)	`Position` 두 개 이상의 요소가 있는 숫자 배열입니다. 처음 두 요소는 경도 및 위도순서대로 정확하게 표시됩니다. 고도/상승 선택적 세 번째 요소입니다. 자세한 내용은 RFC 7946 참조하세요.
type	string: Point	`GeoJSON` 형식을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, FeatureCollection 등 유효한 9가지 GeoJSON 개체 형식 중 하나여야 합니다.

GeoJsonPolygon

Object

유효한 GeoJSON Polygon 기하 도형 형식입니다. 자세한 내용은 RFC 7946 참조하세요.

Name	형식	Description
coordinates	number[] (double)	`GeoJson Polygon` 기하 도형 형식의 좌표입니다.
type	string: Polygon	`GeoJSON` 형식을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, FeatureCollection 등 유효한 9가지 GeoJSON 개체 형식 중 하나여야 합니다.

JsonFormat

열거형

원하는 응답 형식입니다. json 형식만 지원됩니다.

값	Description
json	JavaScript 개체 표기법 데이터 교환 형식

Polygon

Object

Name	형식	Description
geometryData	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	GeoJSON 형식의 기하 도형 데이터입니다. 자세한 내용은 RFC 7946 참조하세요. "error"가 없는 경우에만 표시됩니다.
providerID	string	반환된 엔터티의 ID

PolygonResult

Object

이 개체는 성공적인 검색 다각형 호출에서 반환됩니다.

Name	형식	Description
additionalData	Polygon[]	결과 배열

다음을 통해 공유

Search - Get Search Polygon

URI 매개 변수

요청 헤더

응답

보안

AADToken

범위

subscription-key

SAS Token

예제

Get the Geometry using the geometry id returned by the previous Search

샘플 요청

샘플 응답

정의

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonFeature

GeoJsonFeatureCollection

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

JsonFormat

Polygon

PolygonResult

추가 리소스