@azure-rest/maps-search package

Antarmuka

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput	Alamat hasil
BoundaryOutput	GeoJSON GeocodingFeature objek yang menjelaskan batas area geografis. Geometri fitur ini dijelaskan dengan GeoJSON GeometryCollection. Harap dicatat, layanan ini biasanya mengembalikan GeometryCollection dengan subtipe Poligon atau MultiPolygon.
BoundaryPropertiesOutput	Properti objek Batas.
ErrorAdditionalInfoOutput	Info tambahan kesalahan manajemen sumber daya.
ErrorDetailOutput	Detail kesalahan.
ErrorResponseOutput	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput	Jenis objek GeoJSON FeatureCollection yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent	Jenis objek GeoJSON Feature yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput	Jenis objek GeoJSON GeometryCollection yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonGeometryOutputParent	Objek geometri GeoJSON yang valid. Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonLineStringDataOutput
GeoJsonLineStringOutput	Jenis geometri GeoJSON LineString yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput	Jenis geometri GeoJSON MultiLineString yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonMultiPointDataOutput	Data yang dimuat oleh GeoJson MultiPoint.
GeoJsonMultiPointOutput	Jenis geometri GeoJSON MultiPoint yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput	Jenis objek GeoJSON MultiPolygon yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonObjectOutputParent	Objek GeoJSON yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonPointDataOutput	Data yang dimuat oleh GeoJson Point.
GeoJsonPointOutput	Jenis geometri GeoJSON Point yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonPolygonDataOutput
GeoJsonPolygonOutput	Jenis geometri GeoJSON Polygon yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeocodePointsItemOutput
GeocodingBatchRequestBody	Daftar kueri/permintaan geocoding alamat untuk diproses. Daftar dapat berisi maksimal 100 kueri dan harus berisi setidaknya 1 kueri.
GeocodingBatchRequestItem	Objek Kueri Batch
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput	Objek ini dikembalikan dari panggilan layanan Batch Geocoding yang berhasil.
GeocodingBatchResponseSummaryOutput	Ringkasan untuk permintaan batch
GeocodingResponseOutput	Objek ini dikembalikan dari panggilan Geocoding yang berhasil
GeometryCopyrightOutput	Informasi hak cipta geometri objek Batas.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput	Alamat hasilnya.
MapsSearchClientOptions	Parameter opsional untuk klien
ReverseGeocodingBatchRequestBody	Daftar kueri/permintaan geocoding terbalik untuk diproses. Daftar dapat berisi maksimal 100 kueri dan harus berisi setidaknya 1 kueri.
ReverseGeocodingBatchRequestItem	Objek Kueri Batch
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response	API Get Geocoding adalah permintaan GET HTTP yang mengembalikan koordinat bujur dan lintang lokasi yang sedang dicari. Dalam banyak kasus, layanan pencarian lengkap mungkin terlalu banyak, misalnya jika Anda hanya tertarik dengan geocoding tradisional. Pencarian juga dapat diakses untuk pencarian alamat secara eksklusif. Geocoding dilakukan dengan mencapai titik akhir geocoding hanya dengan alamat atau alamat parsial yang dimaksud. Indeks pencarian geocoding akan dikueri untuk segala sesuatu di atas data tingkat jalan. Tidak ada Point of Interest (POI) yang akan dikembalikan. Perhatikan bahwa geocoder sangat toleran terhadap kesalahan ketik dan alamat yang tidak lengkap. Ini juga akan menangani semuanya dari alamat jalan atau jalan atau persimpangan yang tepat serta geografi tingkat yang lebih tinggi seperti pusat kota, kabupaten, dan negara bagian. Respons juga mengembalikan properti alamat terperinci seperti informasi jalan, kode pos, kotamadya, dan negara/wilayah.
SearchGetGeocodingBatch200Response	API Get Geocoding Batch adalah permintaan POST HTTP yang mengirim batch hingga 100 kueri ke Geocoding API dalam satu permintaan. Kirim Permintaan Batch Sinkron API Sinkron direkomendasikan untuk permintaan batch ringan. Ketika layanan menerima permintaan, layanan akan merespons segera setelah item batch dihitung dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. API Sinkron akan mengembalikan kesalahan waktu habis (respons 408) jika permintaan membutuhkan waktu lebih dari 60 detik. Jumlah item batch dibatasi hingga 100 untuk API ini. POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 Isi POST untuk Permintaan Batch Untuk mengirim kueri geocoding , Anda akan menggunakan permintaan di mana isi permintaan akan berisi array dalam format dan header akan diatur ke . Berikut adalah contoh isi permintaan yang berisi 2 kueri geocoding : { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } Objek geocoding batchItem dapat menerima salah satu geocoding yang didukungparameter URI. Batch harus berisi setidaknya kueri 1. Model Respons Batch Respons batch berisi komponen summary yang menunjukkan totalRequests yang merupakan bagian dari permintaan batch asli dan successfulRequests yaitu kueri yang berhasil dijalankan. Respons batch juga menyertakan array batchItems yang berisi respons untuk setiap kueri dalam permintaan batch. batchItems akan berisi hasil dalam urutan yang sama persis dengan kueri asli yang dikirim dalam permintaan batch. Setiap item adalah salah satu jenis berikut: GeocodingResponse - Jika kueri berhasil diselesaikan. Error - Jika kueri gagal. Respons akan berisi code dan message dalam kasus ini.
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse	API Get Geocoding Batch adalah permintaan POST HTTP yang mengirim batch hingga 100 kueri ke Geocoding API dalam satu permintaan. Kirim Permintaan Batch Sinkron API Sinkron direkomendasikan untuk permintaan batch ringan. Ketika layanan menerima permintaan, layanan akan merespons segera setelah item batch dihitung dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. API Sinkron akan mengembalikan kesalahan waktu habis (respons 408) jika permintaan membutuhkan waktu lebih dari 60 detik. Jumlah item batch dibatasi hingga 100 untuk API ini. POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 Isi POST untuk Permintaan Batch Untuk mengirim kueri geocoding , Anda akan menggunakan permintaan di mana isi permintaan akan berisi array dalam format dan header akan diatur ke . Berikut adalah contoh isi permintaan yang berisi 2 kueri geocoding : { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } Objek geocoding batchItem dapat menerima salah satu geocoding yang didukungparameter URI. Batch harus berisi setidaknya kueri 1. Model Respons Batch Respons batch berisi komponen summary yang menunjukkan totalRequests yang merupakan bagian dari permintaan batch asli dan successfulRequests yaitu kueri yang berhasil dijalankan. Respons batch juga menyertakan array batchItems yang berisi respons untuk setiap kueri dalam permintaan batch. batchItems akan berisi hasil dalam urutan yang sama persis dengan kueri asli yang dikirim dalam permintaan batch. Setiap item adalah salah satu jenis berikut: GeocodingResponse - Jika kueri berhasil diselesaikan. Error - Jika kueri gagal. Respons akan berisi code dan message dalam kasus ini.
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse	API Get Geocoding adalah permintaan GET HTTP yang mengembalikan koordinat bujur dan lintang lokasi yang sedang dicari. Dalam banyak kasus, layanan pencarian lengkap mungkin terlalu banyak, misalnya jika Anda hanya tertarik dengan geocoding tradisional. Pencarian juga dapat diakses untuk pencarian alamat secara eksklusif. Geocoding dilakukan dengan mencapai titik akhir geocoding hanya dengan alamat atau alamat parsial yang dimaksud. Indeks pencarian geocoding akan dikueri untuk segala sesuatu di atas data tingkat jalan. Tidak ada Point of Interest (POI) yang akan dikembalikan. Perhatikan bahwa geocoder sangat toleran terhadap kesalahan ketik dan alamat yang tidak lengkap. Ini juga akan menangani semuanya dari alamat jalan atau jalan atau persimpangan yang tepat serta geografi tingkat yang lebih tinggi seperti pusat kota, kabupaten, dan negara bagian. Respons juga mengembalikan properti alamat terperinci seperti informasi jalan, kode pos, kotamadya, dan negara/wilayah.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response	API Get Polygon adalah permintaan GET HTTP yang memasok data poligon dari kerangka area geografis seperti kota atau wilayah negara.
SearchGetPolygonDefaultResponse	API Get Polygon adalah permintaan GET HTTP yang memasok data poligon dari kerangka area geografis seperti kota atau wilayah negara.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response	API Get Reverse Geocoding adalah permintaan http GET yang digunakan untuk menerjemahkan koordinat (misalnya: 37.786505, -122.3862) ke alamat jalan yang dapat dimengerti manusia. Berguna dalam melacak aplikasi di mana Anda menerima umpan GPS dari perangkat atau aset dan ingin mengetahui alamat yang terkait dengan koordinat. Titik akhir ini akan mengembalikan informasi alamat untuk koordinat tertentu.
SearchGetReverseGeocodingBatch200Response	API Get Reverse Geocoding Batch adalah permintaan POST HTTP yang mengirim batch hingga 100 kueri ke Reverse Geocoding API menggunakan satu permintaan. Kirim Permintaan Batch Sinkron API Sinkron direkomendasikan untuk permintaan batch ringan. Ketika layanan menerima permintaan, layanan akan merespons segera setelah item batch dihitung dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. API Sinkron akan mengembalikan kesalahan waktu habis (respons 408) jika permintaan membutuhkan waktu lebih dari 60 detik. Jumlah item batch dibatasi hingga 100 untuk API ini. POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01 Isi POST untuk Permintaan Batch Untuk mengirim kueri geocoding terbalik , Anda akan menggunakan permintaan di mana isi permintaan akan berisi array dalam format dan header akan diatur ke . Berikut adalah isi permintaan sampel yang berisi 2 kueri geocoding terbalik : { "batchItems": [ { "coordinates": [-122.128275, 47.639429], "resultTypes": ["Address", "PopulatedPlace"] }, { "coordinates": [-122.341979399674, 47.6095253501216] } ] } Objek batchItem geocoding terbalik dapat menerima salah satu parameter geocoding terbalik yang didukungURI. Batch harus berisi setidaknya kueri 1. Model Respons Batch Respons batch berisi komponen summary yang menunjukkan totalRequests yang merupakan bagian dari permintaan batch asli dan successfulRequests yaitu kueri yang berhasil dijalankan. Respons batch juga menyertakan array batchItems yang berisi respons untuk setiap kueri dalam permintaan batch. batchItems akan berisi hasil dalam urutan yang sama persis dengan kueri asli yang dikirim dalam permintaan batch. Setiap item adalah salah satu jenis berikut: GeocodingResponse - Jika kueri berhasil diselesaikan. Error - Jika kueri gagal. Respons akan berisi code dan message dalam kasus ini.
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse	API Get Reverse Geocoding Batch adalah permintaan POST HTTP yang mengirim batch hingga 100 kueri ke Reverse Geocoding API menggunakan satu permintaan. Kirim Permintaan Batch Sinkron API Sinkron direkomendasikan untuk permintaan batch ringan. Ketika layanan menerima permintaan, layanan akan merespons segera setelah item batch dihitung dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. API Sinkron akan mengembalikan kesalahan waktu habis (respons 408) jika permintaan membutuhkan waktu lebih dari 60 detik. Jumlah item batch dibatasi hingga 100 untuk API ini. POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01 Isi POST untuk Permintaan Batch Untuk mengirim kueri geocoding terbalik , Anda akan menggunakan permintaan di mana isi permintaan akan berisi array dalam format dan header akan diatur ke . Berikut adalah isi permintaan sampel yang berisi 2 kueri geocoding terbalik : { "batchItems": [ { "coordinates": [-122.128275, 47.639429], "resultTypes": ["Address", "PopulatedPlace"] }, { "coordinates": [-122.341979399674, 47.6095253501216] } ] } Objek batchItem geocoding terbalik dapat menerima salah satu parameter geocoding terbalik yang didukungURI. Batch harus berisi setidaknya kueri 1. Model Respons Batch Respons batch berisi komponen summary yang menunjukkan totalRequests yang merupakan bagian dari permintaan batch asli dan successfulRequests yaitu kueri yang berhasil dijalankan. Respons batch juga menyertakan array batchItems yang berisi respons untuk setiap kueri dalam permintaan batch. batchItems akan berisi hasil dalam urutan yang sama persis dengan kueri asli yang dikirim dalam permintaan batch. Setiap item adalah salah satu jenis berikut: GeocodingResponse - Jika kueri berhasil diselesaikan. Error - Jika kueri gagal. Respons akan berisi code dan message dalam kasus ini.
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse	API Get Reverse Geocoding adalah permintaan http GET yang digunakan untuk menerjemahkan koordinat (misalnya: 37.786505, -122.3862) ke alamat jalan yang dapat dimengerti manusia. Berguna dalam melacak aplikasi di mana Anda menerima umpan GPS dari perangkat atau aset dan ingin mengetahui alamat yang terkait dengan koordinat. Titik akhir ini akan mengembalikan informasi alamat untuk koordinat tertentu.
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Alias Jenis

GeoJsonFeatureOutput	Jenis objek GeoJSON Feature yang valid. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonGeometryOutput	Objek geometri GeoJSON yang valid. Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan lihat RFC 7946 untuk detailnya.
GeoJsonObjectOutput	Objek GeoJSON yang valid. Silakan lihat RFC 7946 untuk detailnya.
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

Fungsi

default(AzureKeyCredential, ClientOptions)	Membuat instans MapsSearchClient dari kunci langganan. Contoh 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)	Membuat instans MapsSearch dari Azure Identity TokenCredential. Contoh 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)	Membuat instans MapsSearch dari Azure Identity AzureSASCredential. Contoh 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)

Detail Fungsi

default(AzureKeyCredential, ClientOptions)

Membuat instans MapsSearchClient dari kunci langganan.

Contoh

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

Parameter

credential

AzureKeyCredential

Instans AzureKeyCredential yang digunakan untuk mengautentikasi permintaan ke layanan

options

ClientOptions

Opsi yang digunakan untuk mengonfigurasi Klien Pencarian

Mengembalikan

MapsSearchClient

default(TokenCredential, string, ClientOptions)

Membuat instans MapsSearch dari Azure Identity TokenCredential.

Contoh

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

Parameter

credential

TokenCredential

Instans TokenCredential yang digunakan untuk mengautentikasi permintaan ke layanan

mapsAccountClientId

string

Id klien Azure Maps dari sumber daya peta tertentu

options

ClientOptions

Opsi yang digunakan untuk mengonfigurasi Klien Pencarian

Mengembalikan

MapsSearchClient

default(AzureSASCredential, ClientOptions)

Membuat instans MapsSearch dari Azure Identity AzureSASCredential.

Contoh

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

Parameter

credential

AzureSASCredential

Instans AzureSASCredential yang digunakan untuk mengautentikasi permintaan ke layanan

options

ClientOptions

Opsi yang digunakan untuk mengonfigurasi Klien Pencarian

Mengembalikan

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Parameter

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

Mengembalikan

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Parameter

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

Mengembalikan

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Parameter

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

Mengembalikan

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Parameter

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

Mengembalikan

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Parameter

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

Mengembalikan

response