다음을 통해 공유


@azure-rest/maps-search package

인터페이스

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput

결과의 주소입니다.

BoundaryOutput

GeoJSON GeocodingFeature 지리적 영역의 경계를 설명하는 개체입니다. 기능의 기하 도형은 GeoJSON GeometryCollection설명합니다.

이 서비스는 일반적으로 다각형 또는 MultiPolygon 하위 형식을 사용하여 GeometryCollection을 반환합니다.

BoundaryPropertiesOutput

Boundary 개체의 속성입니다.

ErrorAdditionalInfoOutput

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

ErrorDetailOutput

오류 세부 정보입니다.

ErrorResponseOutput

실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. 또한 OData 오류 응답 형식을 따릅니다.

FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput

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

GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent

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

GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput

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

GeoJsonGeometryOutputParent

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

GeoJsonLineStringDataOutput
GeoJsonLineStringOutput

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

GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput

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

GeoJsonMultiPointDataOutput

GeoJson MultiPoint포함된 데이터입니다.

GeoJsonMultiPointOutput

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

GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput

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

GeoJsonObjectOutputParent

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

GeoJsonPointDataOutput

GeoJson Point포함된 데이터입니다.

GeoJsonPointOutput

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

GeoJsonPolygonDataOutput
GeoJsonPolygonOutput

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

GeocodePointsItemOutput
GeocodingBatchRequestBody

처리할 주소 지오코딩 쿼리/요청 목록입니다. 목록에는 최대 100개의 쿼리가 포함될 수 있으며 1개 이상의 쿼리가 포함되어야 합니다.

GeocodingBatchRequestItem

Batch 쿼리 개체

GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput

이 개체는 성공적인 Geocoding Batch 서비스 호출에서 반환됩니다.

GeocodingBatchResponseSummaryOutput

일괄 처리 요청에 대한 요약

GeocodingResponseOutput

이 개체는 성공적인 지오코딩 호출에서 반환됩니다.

GeometryCopyrightOutput

경계 개체의 기하 도형에 대한 저작권 정보입니다.

GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput

결과의 주소입니다.

MapsSearchClientOptions

클라이언트에 대한 선택적 매개 변수

ReverseGeocodingBatchRequestBody

처리할 역방향 지오코딩 쿼리/요청 목록입니다. 목록에는 최대 100개의 쿼리가 포함될 수 있으며 1개 이상의 쿼리가 포함되어야 합니다.

ReverseGeocodingBatchRequestItem

Batch 쿼리 개체

Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response

Get Geocoding API는 검색되는 위치의 경도 및 위도 좌표를 반환하는 HTTP GET 요청입니다.

대부분의 경우 전체 검색 서비스가 너무 많을 수 있습니다. 예를 들어 기존 지오코딩에만 관심이 있는 경우입니다. 주소 조회에 대한 검색에만 액세스할 수도 있습니다. 지오코딩은 해당 주소 또는 부분 주소로 지오코딩 엔드포인트를 눌러 수행됩니다. 지오코딩 검색 인덱스가 거리 수준 데이터 위의 모든 항목에 대해 쿼리됩니다. POI(관심 지점 없음)가 반환되지 않습니다. 지오코더는 오타 및 불완전한 주소에 매우 관대합니다. 또한 정확한 거리 주소, 거리 또는 교차로뿐만 아니라 도심, 카운티 및 주와 같은 높은 수준의 지역에서 모든 것을 처리합니다. 또한 이 응답은 거리, 우편 번호, 지방 자치 단체 및 국가/지역 정보와 같은 자세한 주소 속성을 반환합니다.

SearchGetGeocodingBatch200Response

Get Geocoding Batch API는 단일 요청에서 지오코딩 API에 최대 100개의 쿼리 일괄 처리를 보내는 HTTP POST 요청입니다.

동기 일괄 처리 요청 제출

간단한 일괄 처리 요청에는 동기 API를 사용하는 것이 좋습니다. 서비스가 요청을 받으면 일괄 처리 항목이 계산되는 즉시 응답하며 나중에 결과를 검색할 가능성이 없습니다. 요청이 60초보다 오래 걸리는 경우 동기 API는 시간 제한 오류(408 응답)를 반환합니다. 일괄 처리 항목 수는 이 API에 대해 100개 제한됩니다.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

Batch 요청에 대한 POST 본문

지오코딩 쿼리를 보내려면 요청 본문에 POST 형식의 batchItems 배열이 포함되고 json 헤더가 Content-Type설정되는 application/json 요청을 사용합니다. 다음은 2개의 지오코딩 쿼리를 포함하는 샘플 요청 본문입니다.

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

지오코딩 batchItem 개체는 지원되는 지오코딩URI 매개 변수수락할 수 있습니다.

일괄 처리에는 1개 이상의 쿼리가 포함되어야 합니다.

Batch 응답 모델

일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 summary 성공적으로 실행된 쿼리와 totalRequests 나타내는 successfulRequests 구성 요소가 포함되어 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 모든 쿼리에 대한 응답이 포함된 batchItems 배열도 포함됩니다. batchItems 일괄 처리 요청에서 원래 쿼리가 전송된 순서와 정확히 동일한 순서로 결과를 포함합니다. 각 항목은 다음 유형 중 하나입니다.

  • GeocodingResponse - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우 응답에는 이 경우 codemessage 포함됩니다.

SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse

Get Geocoding Batch API는 단일 요청에서 지오코딩 API에 최대 100개의 쿼리 일괄 처리를 보내는 HTTP POST 요청입니다.

동기 일괄 처리 요청 제출

간단한 일괄 처리 요청에는 동기 API를 사용하는 것이 좋습니다. 서비스가 요청을 받으면 일괄 처리 항목이 계산되는 즉시 응답하며 나중에 결과를 검색할 가능성이 없습니다. 요청이 60초보다 오래 걸리는 경우 동기 API는 시간 제한 오류(408 응답)를 반환합니다. 일괄 처리 항목 수는 이 API에 대해 100개 제한됩니다.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

Batch 요청에 대한 POST 본문

지오코딩 쿼리를 보내려면 요청 본문에 POST 형식의 batchItems 배열이 포함되고 json 헤더가 Content-Type설정되는 application/json 요청을 사용합니다. 다음은 2개의 지오코딩 쿼리를 포함하는 샘플 요청 본문입니다.

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

지오코딩 batchItem 개체는 지원되는 지오코딩URI 매개 변수수락할 수 있습니다.

일괄 처리에는 1개 이상의 쿼리가 포함되어야 합니다.

Batch 응답 모델

일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 summary 성공적으로 실행된 쿼리와 totalRequests 나타내는 successfulRequests 구성 요소가 포함되어 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 모든 쿼리에 대한 응답이 포함된 batchItems 배열도 포함됩니다. batchItems 일괄 처리 요청에서 원래 쿼리가 전송된 순서와 정확히 동일한 순서로 결과를 포함합니다. 각 항목은 다음 유형 중 하나입니다.

  • GeocodingResponse - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우 응답에는 이 경우 codemessage 포함됩니다.

SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse

Get Geocoding API는 검색되는 위치의 경도 및 위도 좌표를 반환하는 HTTP GET 요청입니다.

대부분의 경우 전체 검색 서비스가 너무 많을 수 있습니다. 예를 들어 기존 지오코딩에만 관심이 있는 경우입니다. 주소 조회에 대한 검색에만 액세스할 수도 있습니다. 지오코딩은 해당 주소 또는 부분 주소로 지오코딩 엔드포인트를 눌러 수행됩니다. 지오코딩 검색 인덱스가 거리 수준 데이터 위의 모든 항목에 대해 쿼리됩니다. POI(관심 지점 없음)가 반환되지 않습니다. 지오코더는 오타 및 불완전한 주소에 매우 관대합니다. 또한 정확한 거리 주소, 거리 또는 교차로뿐만 아니라 도심, 카운티 및 주와 같은 높은 수준의 지역에서 모든 것을 처리합니다. 또한 이 응답은 거리, 우편 번호, 지방 자치 단체 및 국가/지역 정보와 같은 자세한 주소 속성을 반환합니다.

SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response

Get Polygon API는 도시 또는 국가 지역과 같은 지리적 영역 개요의 다각형 데이터를 제공하는 HTTP GET 요청입니다.

SearchGetPolygonDefaultResponse

Get Polygon API는 도시 또는 국가 지역과 같은 지리적 영역 개요의 다각형 데이터를 제공하는 HTTP GET 요청입니다.

SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response

Get Reverse Geocoding API는 좌표(예: 37.786505, -122.3862)를 사람이 이해할 수 있는 거리 주소로 변환하는 데 사용되는 HTTP GET 요청입니다. 디바이스 또는 자산에서 GPS 피드를 수신하고 좌표와 연결된 주소를 알고자 하는 애플리케이션을 추적하는 데 유용합니다. 이 엔드포인트는 지정된 좌표에 대한 주소 정보를 반환합니다.

SearchGetReverseGeocodingBatch200Response

API는 단일 요청을 사용하여 역방향 지오코딩 API를 위해 최대 100개의 쿼리 일괄 처리를 보내는 HTTP 요청입니다.

동기 일괄 처리 요청 제출

간단한 일괄 처리 요청에는 동기 API를 사용하는 것이 좋습니다. 서비스가 요청을 받으면 일괄 처리 항목이 계산되는 즉시 응답하며 나중에 결과를 검색할 가능성이 없습니다. 요청이 60초보다 오래 걸리는 경우 동기 API는 시간 제한 오류(408 응답)를 반환합니다. 일괄 처리 항목 수는 이 API에 대해 100개 제한됩니다.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

Batch 요청에 대한 POST 본문

역방향 지오코딩 쿼리를 보내려면 요청 본문에 batchItems 배열이 json 형식으로 포함되고 Content-Type 헤더가 application/json설정되는 POST 요청을 사용합니다. 다음은 2개의 역방향 지오코딩 쿼리를 포함하는 샘플 요청 본문입니다.

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

역방향 지오코딩 batchItem 개체는 지원되는 역방향 지오코딩URI 매개 변수수락할 수 있습니다.

일괄 처리에는 1개 이상의 쿼리가 포함되어야 합니다.

Batch 응답 모델

일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 summary 성공적으로 실행된 쿼리와 totalRequests 나타내는 successfulRequests 구성 요소가 포함되어 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 모든 쿼리에 대한 응답이 포함된 batchItems 배열도 포함됩니다. batchItems 일괄 처리 요청에서 원래 쿼리가 전송된 순서와 정확히 동일한 순서로 결과를 포함합니다. 각 항목은 다음 유형 중 하나입니다.

  • GeocodingResponse - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우 응답에는 이 경우 codemessage 포함됩니다.

SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse

API는 단일 요청을 사용하여 역방향 지오코딩 API를 위해 최대 100개의 쿼리 일괄 처리를 보내는 HTTP 요청입니다.

동기 일괄 처리 요청 제출

간단한 일괄 처리 요청에는 동기 API를 사용하는 것이 좋습니다. 서비스가 요청을 받으면 일괄 처리 항목이 계산되는 즉시 응답하며 나중에 결과를 검색할 가능성이 없습니다. 요청이 60초보다 오래 걸리는 경우 동기 API는 시간 제한 오류(408 응답)를 반환합니다. 일괄 처리 항목 수는 이 API에 대해 100개 제한됩니다.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

Batch 요청에 대한 POST 본문

역방향 지오코딩 쿼리를 보내려면 요청 본문에 batchItems 배열이 json 형식으로 포함되고 Content-Type 헤더가 application/json설정되는 POST 요청을 사용합니다. 다음은 2개의 역방향 지오코딩 쿼리를 포함하는 샘플 요청 본문입니다.

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

역방향 지오코딩 batchItem 개체는 지원되는 역방향 지오코딩URI 매개 변수수락할 수 있습니다.

일괄 처리에는 1개 이상의 쿼리가 포함되어야 합니다.

Batch 응답 모델

일괄 처리 응답에는 원래 일괄 처리 요청의 일부인 summary 성공적으로 실행된 쿼리와 totalRequests 나타내는 successfulRequests 구성 요소가 포함되어 있습니다. 일괄 처리 응답에는 일괄 처리 요청의 모든 쿼리에 대한 응답이 포함된 batchItems 배열도 포함됩니다. batchItems 일괄 처리 요청에서 원래 쿼리가 전송된 순서와 정확히 동일한 순서로 결과를 포함합니다. 각 항목은 다음 유형 중 하나입니다.

  • GeocodingResponse - 쿼리가 성공적으로 완료된 경우

  • Error - 쿼리가 실패한 경우 응답에는 이 경우 codemessage 포함됩니다.

SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse

Get Reverse Geocoding API는 좌표(예: 37.786505, -122.3862)를 사람이 이해할 수 있는 거리 주소로 변환하는 데 사용되는 HTTP GET 요청입니다. 디바이스 또는 자산에서 GPS 피드를 수신하고 좌표와 연결된 주소를 알고자 하는 애플리케이션을 추적하는 데 유용합니다. 이 엔드포인트는 지정된 좌표에 대한 주소 정보를 반환합니다.

SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

형식 별칭

GeoJsonFeatureOutput

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

GeoJsonGeometryOutput

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

GeoJsonObjectOutput

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

MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

함수

default(AzureKeyCredential, ClientOptions)

구독 키에서 MapsSearchClient의 인스턴스를 만듭니다.

예제

import MapsSearch from "@azure-rest/maps-search";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);
default(TokenCredential, string, ClientOptions)

Azure ID TokenCredentialMapsSearch 인스턴스를 만듭니다.

예제

import MapsSearch from "@azure-rest/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

Azure ID AzureSASCredentialMapsSearch 인스턴스를 만듭니다.

예제

import MapsSearch from "@azure-rest/maps-search";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);
isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)
isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)
isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)
isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)
isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

함수 세부 정보

default(AzureKeyCredential, ClientOptions)

구독 키에서 MapsSearchClient의 인스턴스를 만듭니다.

예제

import MapsSearch from "@azure-rest/maps-search";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);
function default(credential: AzureKeyCredential, options?: ClientOptions): MapsSearchClient

매개 변수

credential
AzureKeyCredential

서비스에 대한 요청을 인증하는 데 사용되는 AzureKeyCredential 인스턴스

options
ClientOptions

Search 클라이언트를 구성하는 데 사용되는 옵션

반환

default(TokenCredential, string, ClientOptions)

Azure ID TokenCredentialMapsSearch 인스턴스를 만듭니다.

예제

import MapsSearch from "@azure-rest/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");
function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsSearchClient

매개 변수

credential
TokenCredential

서비스에 대한 요청을 인증하는 데 사용되는 TokenCredential 인스턴스

mapsAccountClientId

string

특정 맵 리소스의 Azure Maps 클라이언트 ID

options
ClientOptions

Search 클라이언트를 구성하는 데 사용되는 옵션

반환

default(AzureSASCredential, ClientOptions)

Azure ID AzureSASCredentialMapsSearch 인스턴스를 만듭니다.

예제

import MapsSearch from "@azure-rest/maps-search";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);
function default(credential: AzureSASCredential, options?: ClientOptions): MapsSearchClient

매개 변수

credential
AzureSASCredential

서비스에 대한 요청을 인증하는 데 사용되는 AzureSASCredential 인스턴스

options
ClientOptions

Search 클라이언트를 구성하는 데 사용되는 옵션

반환

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

매개 변수

반환

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

매개 변수

반환

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

매개 변수

반환

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

매개 변수

반환

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

매개 변수

반환

response