Aracılığıyla paylaş


@azure-rest/maps-search package

Arabirimler

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput

Sonucun adresi

BoundaryOutput

GeoJSON GeocodingFeature bir coğrafi alanın sınırlarını açıklayan nesne. Özelliğin geometrisi GeoJSON GeometryCollectionile açıklanmıştır.

Hizmetin genellikle Polygon veya MultiPolygon alt türlerine sahip bir GeometryCollection döndürdüğüne dikkat edin.

BoundaryPropertiesOutput

Sınır nesnesinin özellikleri.

ErrorAdditionalInfoOutput

Kaynak yönetimi hatası ek bilgileri.

ErrorDetailOutput

Hata ayrıntısı.

ErrorResponseOutput

Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).

FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput

Geçerli bir GeoJSON FeatureCollection nesne türü. Ayrıntılar için lütfen RFC 7946 bakın.

GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent

Geçerli bir GeoJSON Feature nesne türü. Ayrıntılar için lütfen RFC 7946 bakın.

GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput

Geçerli bir GeoJSON GeometryCollection nesne türü. Ayrıntılar için lütfen RFC 7946 bakın.

GeoJsonGeometryOutputParent

Geçerli bir GeoJSON geometri nesnesi. Tür yedi geçerli GeoJSON geometri türünden biri olmalıdır: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon ve GeometryCollection. Ayrıntılar için lütfen RFC 7946 bakın.

GeoJsonLineStringDataOutput
GeoJsonLineStringOutput

Geçerli bir GeoJSON LineString geometri türü. Ayrıntılar için lütfen RFC 7946 bakın.

GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput

Geçerli bir GeoJSON MultiLineString geometri türü. Ayrıntılar için lütfen RFC 7946 bakın.

GeoJsonMultiPointDataOutput

GeoJson MultiPointtarafından kapsanan veriler.

GeoJsonMultiPointOutput

Geçerli bir GeoJSON MultiPoint geometri türü. Ayrıntılar için lütfen RFC 7946 bakın.

GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput

Geçerli bir GeoJSON MultiPolygon nesne türü. Ayrıntılar için lütfen RFC 7946 bakın.

GeoJsonObjectOutputParent

Geçerli bir GeoJSON nesnesi. Ayrıntılar için lütfen RFC 7946 bakın.

GeoJsonPointDataOutput

GeoJson Pointtarafından kapsanan veriler.

GeoJsonPointOutput

Geçerli bir GeoJSON Point geometri türü. Ayrıntılar için lütfen RFC 7946 bakın.

GeoJsonPolygonDataOutput
GeoJsonPolygonOutput

Geçerli bir GeoJSON Polygon geometri türü. Ayrıntılar için lütfen RFC 7946 bakın.

GeocodePointsItemOutput
GeocodingBatchRequestBody

İşlenmesi gereken adres coğrafi kodlama sorgularının/isteklerinin listesi. Liste en fazla 100 sorgu içerebilir ve en az 1 sorgu içermelidir.

GeocodingBatchRequestItem

Batch Query nesnesi

GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput

Bu nesne başarılı bir Geocoding Batch hizmet çağrısından döndürülür.

GeocodingBatchResponseSummaryOutput

Toplu iş isteğinin özeti

GeocodingResponseOutput

Bu nesne başarılı bir Coğrafi Kodlama çağrısından döndürülür

GeometryCopyrightOutput

Sınır nesnesinin geometrisinin telif hakkı bilgileri.

GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput

Sonucun adresi.

MapsSearchClientOptions

İstemci için isteğe bağlı parametreler

ReverseGeocodingBatchRequestBody

İşlenmesi gereken ters coğrafi kodlama sorgularının/isteklerinin listesi. Liste en fazla 100 sorgu içerebilir ve en az 1 sorgu içermelidir.

ReverseGeocodingBatchRequestItem

Batch Query nesnesi

Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response

Get Geocoding API,aranmakta olan konumun boylam ve enlem koordinatlarını döndüren bir HTTP GET isteğidir.

Çoğu durumda, yalnızca geleneksel coğrafi kodlamayla ilgileniyorsanız, tam arama hizmeti çok fazla olabilir. Yalnızca adres arama için de arama yapılabilir. Coğrafi kodlama, yalnızca söz konusu adres veya kısmi adresle coğrafi kodlama uç noktasına isabet ederek gerçekleştirilir. Coğrafi kodlama arama dizini, sokak düzeyindeki verilerin üzerindeki her şey için sorgulanır. İlgi Noktası (POI) döndürülmeyecek. Coğrafi kodlayıcının yazım hatalarına ve eksik adreslere çok dayanıklı olduğunu unutmayın. Ayrıca sokak adreslerinden, sokak veya kavşaklardan ve şehir merkezleri, ilçeler ve eyaletler gibi daha üst düzey coğrafyalardan her şeyi ele alacaktır. Yanıt ayrıca sokak, posta kodu, belediye ve ülke/bölge bilgileri gibi ayrıntılı adres özelliklerini döndürür.

SearchGetGeocodingBatch200Response

Get Geocoding Batch API,POST API'sine tek bir istekte en fazla 100 sorgu gönderen bir HTTP isteğidir.

Zaman Uyumlu Toplu İş İsteği Gönderme

Basit toplu istekler için Zaman Uyumlu API önerilir. Hizmet bir istek aldığında, toplu iş öğeleri hesaplanır hesaplanmaz yanıt verir ve sonuçları daha sonra alma imkanı olmaz. İstek 60 saniyeden uzun sürerse Zaman Uyumlu API zaman aşımı hatası (408 yanıtı) döndürür. Toplu iş öğelerinin sayısı, bu API için 100 ile sınırlıdır.

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

Toplu İstek için POST Gövdesi

coğrafi kodlama sorguları göndermek için, istek gövdesinin POST dizisini batchItems biçimde içereceği ve json üst bilgisinin Content-Typeolarak ayarlanacağı application/json bir istek kullanırsınız. 2 coğrafi kodlama sorgu içeren örnek bir istek gövdesi aşağıda verilmişti:

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

coğrafi kodlama batchItem nesnesi,desteklenen coğrafi kodlamaURI parametrelerinden herhangi birini kabul edebilir.

Toplu işlem en az 1 sorgu içermelidir.

Batch Yanıt Modeli

Toplu yanıt, özgün toplu iş isteğinin parçası olan summary belirten bir totalRequests bileşeni ve başarıyla yürütülen sorgular successfulRequests içerir. Toplu yanıt, toplu iş isteğindeki her sorgu için bir yanıt içeren bir batchItems dizisi de içerir. batchItems, sonuçları özgün sorguların toplu iş isteğinde gönderildiği sırayla içerir. Her öğe aşağıdaki türlerden biridir:

  • GeocodingResponse - Sorgu başarıyla tamamlandıysa.

  • Error - Sorgu başarısız olduysa. Yanıt, bu durumda bir code ve bir message içerir.

SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse

Get Geocoding Batch API,POST API'sine tek bir istekte en fazla 100 sorgu gönderen bir HTTP isteğidir.

Zaman Uyumlu Toplu İş İsteği Gönderme

Basit toplu istekler için Zaman Uyumlu API önerilir. Hizmet bir istek aldığında, toplu iş öğeleri hesaplanır hesaplanmaz yanıt verir ve sonuçları daha sonra alma imkanı olmaz. İstek 60 saniyeden uzun sürerse Zaman Uyumlu API zaman aşımı hatası (408 yanıtı) döndürür. Toplu iş öğelerinin sayısı, bu API için 100 ile sınırlıdır.

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

Toplu İstek için POST Gövdesi

coğrafi kodlama sorguları göndermek için, istek gövdesinin POST dizisini batchItems biçimde içereceği ve json üst bilgisinin Content-Typeolarak ayarlanacağı application/json bir istek kullanırsınız. 2 coğrafi kodlama sorgu içeren örnek bir istek gövdesi aşağıda verilmişti:

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

coğrafi kodlama batchItem nesnesi,desteklenen coğrafi kodlamaURI parametrelerinden herhangi birini kabul edebilir.

Toplu işlem en az 1 sorgu içermelidir.

Batch Yanıt Modeli

Toplu yanıt, özgün toplu iş isteğinin parçası olan summary belirten bir totalRequests bileşeni ve başarıyla yürütülen sorgular successfulRequests içerir. Toplu yanıt, toplu iş isteğindeki her sorgu için bir yanıt içeren bir batchItems dizisi de içerir. batchItems, sonuçları özgün sorguların toplu iş isteğinde gönderildiği sırayla içerir. Her öğe aşağıdaki türlerden biridir:

  • GeocodingResponse - Sorgu başarıyla tamamlandıysa.

  • Error - Sorgu başarısız olduysa. Yanıt, bu durumda bir code ve bir message içerir.

SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse

Get Geocoding API,aranmakta olan konumun boylam ve enlem koordinatlarını döndüren bir HTTP GET isteğidir.

Çoğu durumda, yalnızca geleneksel coğrafi kodlamayla ilgileniyorsanız, tam arama hizmeti çok fazla olabilir. Yalnızca adres arama için de arama yapılabilir. Coğrafi kodlama, yalnızca söz konusu adres veya kısmi adresle coğrafi kodlama uç noktasına isabet ederek gerçekleştirilir. Coğrafi kodlama arama dizini, sokak düzeyindeki verilerin üzerindeki her şey için sorgulanır. İlgi Noktası (POI) döndürülmeyecek. Coğrafi kodlayıcının yazım hatalarına ve eksik adreslere çok dayanıklı olduğunu unutmayın. Ayrıca sokak adreslerinden, sokak veya kavşaklardan ve şehir merkezleri, ilçeler ve eyaletler gibi daha üst düzey coğrafyalardan her şeyi ele alacaktır. Yanıt ayrıca sokak, posta kodu, belediye ve ülke/bölge bilgileri gibi ayrıntılı adres özelliklerini döndürür.

SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response

Get Polygon API'si, şehir veya ülke bölgesi gibi bir coğrafi alan ana hattının çokgen verilerini sağlayan bir HTTP GET isteğidir.

SearchGetPolygonDefaultResponse

Get Polygon API'si, şehir veya ülke bölgesi gibi bir coğrafi alan ana hattının çokgen verilerini sağlayan bir HTTP GET isteğidir.

SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response

Get Reverse Geocoding API'si, bir koordinatı (örneğin: 37.786505, -122.3862) anlaşılır bir sokak adresine çevirmek için kullanılan bir HTTP GET isteğidir. Cihazdan veya varlıktan GPS akışı aldığınız ve koordinatlarla ilişkili adresi bilmek istediğiniz uygulamaları izlemede yararlıdır. Bu uç nokta, belirli bir koordinat için adres bilgilerini döndürür.

SearchGetReverseGeocodingBatch200Response

API'si, tek bir istek kullanarak Ters Coğrafi Kodlama API'sine 100'e kadar sorgu içeren toplu işlemler gönderen bir HTTP isteğidir.

Zaman Uyumlu Toplu İş İsteği Gönderme

Basit toplu istekler için Zaman Uyumlu API önerilir. Hizmet bir istek aldığında, toplu iş öğeleri hesaplanır hesaplanmaz yanıt verir ve sonuçları daha sonra alma imkanı olmaz. İstek 60 saniyeden uzun sürerse Zaman Uyumlu API zaman aşımı hatası (408 yanıtı) döndürür. Toplu iş öğelerinin sayısı, bu API için 100 ile sınırlıdır.

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

Toplu İstek için POST Gövdesi

ters coğrafi kodlama sorguları göndermek için, istek gövdesinin dizisini biçimde içereceği ve üst bilgisinin olarak ayarlanacağı bir istek kullanırsınız. Aşağıda 2 ters coğrafi kodlama sorgu içeren bir örnek istek gövdesi verilmişti:

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

ters coğrafi kodlama batchItem nesnesi,desteklenen ters coğrafi kodlamaURI parametrelerinden herhangi birini kabul edebilir.

Toplu işlem en az 1 sorgu içermelidir.

Batch Yanıt Modeli

Toplu yanıt, özgün toplu iş isteğinin parçası olan summary belirten bir totalRequests bileşeni ve başarıyla yürütülen sorgular successfulRequests içerir. Toplu yanıt, toplu iş isteğindeki her sorgu için bir yanıt içeren bir batchItems dizisi de içerir. batchItems, sonuçları özgün sorguların toplu iş isteğinde gönderildiği sırayla içerir. Her öğe aşağıdaki türlerden biridir:

  • GeocodingResponse - Sorgu başarıyla tamamlandıysa.

  • Error - Sorgu başarısız olduysa. Yanıt, bu durumda bir code ve bir message içerir.

SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse

API'si, tek bir istek kullanarak Ters Coğrafi Kodlama API'sine 100'e kadar sorgu içeren toplu işlemler gönderen bir HTTP isteğidir.

Zaman Uyumlu Toplu İş İsteği Gönderme

Basit toplu istekler için Zaman Uyumlu API önerilir. Hizmet bir istek aldığında, toplu iş öğeleri hesaplanır hesaplanmaz yanıt verir ve sonuçları daha sonra alma imkanı olmaz. İstek 60 saniyeden uzun sürerse Zaman Uyumlu API zaman aşımı hatası (408 yanıtı) döndürür. Toplu iş öğelerinin sayısı, bu API için 100 ile sınırlıdır.

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

Toplu İstek için POST Gövdesi

ters coğrafi kodlama sorguları göndermek için, istek gövdesinin dizisini biçimde içereceği ve üst bilgisinin olarak ayarlanacağı bir istek kullanırsınız. Aşağıda 2 ters coğrafi kodlama sorgu içeren bir örnek istek gövdesi verilmişti:

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

ters coğrafi kodlama batchItem nesnesi,desteklenen ters coğrafi kodlamaURI parametrelerinden herhangi birini kabul edebilir.

Toplu işlem en az 1 sorgu içermelidir.

Batch Yanıt Modeli

Toplu yanıt, özgün toplu iş isteğinin parçası olan summary belirten bir totalRequests bileşeni ve başarıyla yürütülen sorgular successfulRequests içerir. Toplu yanıt, toplu iş isteğindeki her sorgu için bir yanıt içeren bir batchItems dizisi de içerir. batchItems, sonuçları özgün sorguların toplu iş isteğinde gönderildiği sırayla içerir. Her öğe aşağıdaki türlerden biridir:

  • GeocodingResponse - Sorgu başarıyla tamamlandıysa.

  • Error - Sorgu başarısız olduysa. Yanıt, bu durumda bir code ve bir message içerir.

SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse

Get Reverse Geocoding API'si, bir koordinatı (örneğin: 37.786505, -122.3862) anlaşılır bir sokak adresine çevirmek için kullanılan bir HTTP GET isteğidir. Cihazdan veya varlıktan GPS akışı aldığınız ve koordinatlarla ilişkili adresi bilmek istediğiniz uygulamaları izlemede yararlıdır. Bu uç nokta, belirli bir koordinat için adres bilgilerini döndürür.

SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Tür Diğer Adları

GeoJsonFeatureOutput

Geçerli bir GeoJSON Feature nesne türü. Ayrıntılar için lütfen RFC 7946 bakın.

GeoJsonGeometryOutput

Geçerli bir GeoJSON geometri nesnesi. Tür yedi geçerli GeoJSON geometri türünden biri olmalıdır: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon ve GeometryCollection. Ayrıntılar için lütfen RFC 7946 bakın.

GeoJsonObjectOutput

Geçerli bir GeoJSON nesnesi. Ayrıntılar için lütfen RFC 7946 bakın.

MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

İşlevler

default(AzureKeyCredential, ClientOptions)

Bir abonelik anahtarından HaritalarSearchClient örneği oluşturur.

Örnek

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)

Bir Azure Identity TokenCredential'ndan MapsSearch örneği oluşturur.

Örnek

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)

Bir Azure Identity AzureSASCredential'ndan MapsSearch örneği oluşturur.

Örnek

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)

İşlev Ayrıntıları

default(AzureKeyCredential, ClientOptions)

Bir abonelik anahtarından HaritalarSearchClient örneği oluşturur.

Örnek

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

Parametreler

credential
AzureKeyCredential

Hizmete yönelik isteklerin kimliğini doğrulamak için kullanılan bir AzureKeyCredential örneği

options
ClientOptions

Arama İstemcisi'ni yapılandırmak için kullanılan seçenekler

Döndürülenler

default(TokenCredential, string, ClientOptions)

Bir Azure Identity TokenCredential'ndan MapsSearch örneği oluşturur.

Örnek

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

Parametreler

credential
TokenCredential

Hizmete yönelik isteklerin kimliğini doğrulamak için kullanılan TokenCredential örneği

mapsAccountClientId

string

Belirli bir harita kaynağının Azure Haritalar istemci kimliği

options
ClientOptions

Arama İstemcisi'ni yapılandırmak için kullanılan seçenekler

Döndürülenler

default(AzureSASCredential, ClientOptions)

Bir Azure Identity AzureSASCredential'ndan MapsSearch örneği oluşturur.

Örnek

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

Parametreler

credential
AzureSASCredential

Hizmete yönelik isteklerin kimliğini doğrulamak için kullanılan bir AzureSASCredential örneği

options
ClientOptions

Arama İstemcisi'ni yapılandırmak için kullanılan seçenekler

Döndürülenler

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Parametreler

Döndürülenler

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Parametreler

Döndürülenler

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Parametreler

Döndürülenler

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Parametreler

Döndürülenler

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Parametreler

Döndürülenler

response