Partager via

@azure-rest/maps-search package

  • Référence

Interfaces

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput

Adresse du résultat
BoundaryOutput

GeoJSON GeocodingFeature objet qui décrivent les limites d’une zone géographique. La géométrie de la fonctionnalité est décrite avec GeoJSON GeometryCollection.

Notez que le service retourne généralement une GeometryCollection avec des sous-types Polygon ou MultiPolygon.
BoundaryPropertiesOutput

Propriétés d’un objet Boundary.
ErrorAdditionalInfoOutput

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetailOutput

Détail de l’erreur.
ErrorResponseOutput

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput

Type d’objet GeoJSON FeatureCollection valide. Pour plus d’informations, reportez-vous à RFC 7946.
GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent

Type d’objet GeoJSON Feature valide. Pour plus d’informations, reportez-vous à RFC 7946.
GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput

Type d’objet GeoJSON GeometryCollection valide. Pour plus d’informations, reportez-vous à RFC 7946.
GeoJsonGeometryOutputParent

Objet geometry GeoJSON valide. Le type doit être l’un des sept types de géométrie GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, reportez-vous à RFC 7946.
GeoJsonLineStringDataOutput
GeoJsonLineStringOutput

Type de géométrie GeoJSON LineString valide. Pour plus d’informations, reportez-vous à RFC 7946.
GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput

Type de géométrie GeoJSON MultiLineString valide. Pour plus d’informations, reportez-vous à RFC 7946.
GeoJsonMultiPointDataOutput

Données contenues dans un GeoJson MultiPoint.
GeoJsonMultiPointOutput

Type de géométrie GeoJSON MultiPoint valide. Pour plus d’informations, reportez-vous à RFC 7946.
GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput

Type d’objet GeoJSON MultiPolygon valide. Pour plus d’informations, reportez-vous à RFC 7946.
GeoJsonObjectOutputParent

Objet GeoJSON valide. Pour plus d’informations, reportez-vous à RFC 7946.
GeoJsonPointDataOutput

Données contenues dans un GeoJson Point.
GeoJsonPointOutput

Type de géométrie GeoJSON Point valide. Pour plus d’informations, reportez-vous à RFC 7946.
GeoJsonPolygonDataOutput
GeoJsonPolygonOutput

Type de géométrie GeoJSON Polygon valide. Pour plus d’informations, reportez-vous à RFC 7946.
GeocodePointsItemOutput
GeocodingBatchRequestBody

Liste des requêtes/requêtes de géocodage d’adresses à traiter. La liste peut contenir un maximum de 100 requêtes et doit contenir au moins 1 requête.
GeocodingBatchRequestItem

Objet Batch Query
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput

Cet objet est retourné à partir d’un appel de service Batch de géocodage réussi.
GeocodingBatchResponseSummaryOutput

Résumé de la demande de traitement par lots
GeocodingResponseOutput

Cet objet est retourné à partir d’un appel de géocodage réussi
GeometryCopyrightOutput

Informations de copyright d’une géométrie d’un objet Boundary.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput

Adresse du résultat.
MapsSearchClientOptions

Paramètres facultatifs pour le client
ReverseGeocodingBatchRequestBody

Liste des requêtes/requêtes de géocodage inversées à traiter. La liste peut contenir un maximum de 100 requêtes et doit contenir au moins 1 requête.
ReverseGeocodingBatchRequestItem

Objet Batch Query
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response

L’API Get Geocoding est une requête HTTP GET qui retourne les coordonnées longitude et latitude de l’emplacement recherché.

Dans de nombreux cas, le service de recherche complet peut être trop important, par exemple si vous n’êtes intéressé que par le géocodage traditionnel. Vous pouvez également accéder à la recherche d’adresses exclusivement. Le géocodage est effectué en appuyant sur le point de terminaison de géocodage avec uniquement l’adresse ou l’adresse partielle en question. L’index de recherche de géocodage sera interrogé pour tous les éléments au-dessus des données au niveau de la rue. Aucun point d’intérêt (POI) n’est retourné. Notez que le géocodeur est très tolérant aux fautes de frappe et aux adresses incomplètes. Il gérera également toutes les adresses de rue exactes, les rues ou les intersections ainsi que les zones géographiques de niveau supérieur telles que les centres urbains, les comtés et les états. La réponse retourne également des propriétés d’adresse détaillées telles que les informations de rue, de code postal, de municipalité et de pays/région.
SearchGetGeocodingBatch200Response

L’API Get Geocoding Batch est une requête http POST qui envoie des lots allant jusqu’à 100 requêtes à l’API de géocodage dans une seule requête.

Envoyer une demande de traitement par lots synchrone

L’API synchrone est recommandée pour les requêtes par lots légères. Lorsque le service reçoit une demande, il répond dès que les éléments de lot sont calculés et il n’y aura aucune possibilité de récupérer les résultats ultérieurement. L’API synchrone retourne une erreur de délai d’expiration (réponse 408) si la requête prend plus de 60 secondes. Le nombre d’éléments de lot est limité à 100 pour cette API.

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

Corps POST pour la requête Batch

Pour envoyer le géocodage requêtes, vous utiliserez une requête POST où le corps de la requête contiendra le tableau batchItems au format json et l’en-tête Content-Type sera défini sur application/json. Voici un exemple de corps de requête contenant 2 géocodage requêtes :

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

Un objet géocodage batchItem peut accepter l’un des paramètres de géocodage pris en charge.

Le lot doit contenir au moins 1 requête.

Modèle de réponse par lot

La réponse par lot contient un composant summary qui indique les totalRequests qui faisaient partie de la demande de lot d’origine et successfulRequests c’est-à-dire les requêtes qui ont été exécutées avec succès. La réponse par lot inclut également un tableau batchItems qui contient une réponse pour chaque requête dans la requête de lot. Les batchItems contiennent les résultats dans le même ordre que les requêtes d’origine ont été envoyées dans la requête de lot. Chaque élément est de l’un des types suivants :

  • GeocodingResponse : si la requête s’est terminée correctement.

  • Error : si la requête a échoué. La réponse contient une code et une message dans ce cas.
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse

L’API Get Geocoding Batch est une requête http POST qui envoie des lots allant jusqu’à 100 requêtes à l’API de géocodage dans une seule requête.

Envoyer une demande de traitement par lots synchrone

L’API synchrone est recommandée pour les requêtes par lots légères. Lorsque le service reçoit une demande, il répond dès que les éléments de lot sont calculés et il n’y aura aucune possibilité de récupérer les résultats ultérieurement. L’API synchrone retourne une erreur de délai d’expiration (réponse 408) si la requête prend plus de 60 secondes. Le nombre d’éléments de lot est limité à 100 pour cette API.

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

Corps POST pour la requête Batch

Pour envoyer le géocodage requêtes, vous utiliserez une requête POST où le corps de la requête contiendra le tableau batchItems au format json et l’en-tête Content-Type sera défini sur application/json. Voici un exemple de corps de requête contenant 2 géocodage requêtes :

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

Un objet géocodage batchItem peut accepter l’un des paramètres de géocodage pris en charge.

Le lot doit contenir au moins 1 requête.

Modèle de réponse par lot

La réponse par lot contient un composant summary qui indique les totalRequests qui faisaient partie de la demande de lot d’origine et successfulRequests c’est-à-dire les requêtes qui ont été exécutées avec succès. La réponse par lot inclut également un tableau batchItems qui contient une réponse pour chaque requête dans la requête de lot. Les batchItems contiennent les résultats dans le même ordre que les requêtes d’origine ont été envoyées dans la requête de lot. Chaque élément est de l’un des types suivants :

  • GeocodingResponse : si la requête s’est terminée correctement.

  • Error : si la requête a échoué. La réponse contient une code et une message dans ce cas.
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse

L’API Get Geocoding est une requête HTTP GET qui retourne les coordonnées longitude et latitude de l’emplacement recherché.

Dans de nombreux cas, le service de recherche complet peut être trop important, par exemple si vous n’êtes intéressé que par le géocodage traditionnel. Vous pouvez également accéder à la recherche d’adresses exclusivement. Le géocodage est effectué en appuyant sur le point de terminaison de géocodage avec uniquement l’adresse ou l’adresse partielle en question. L’index de recherche de géocodage sera interrogé pour tous les éléments au-dessus des données au niveau de la rue. Aucun point d’intérêt (POI) n’est retourné. Notez que le géocodeur est très tolérant aux fautes de frappe et aux adresses incomplètes. Il gérera également toutes les adresses de rue exactes, les rues ou les intersections ainsi que les zones géographiques de niveau supérieur telles que les centres urbains, les comtés et les états. La réponse retourne également des propriétés d’adresse détaillées telles que les informations de rue, de code postal, de municipalité et de pays/région.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response

L’API Get Polygon est une requête HTTP GET qui fournit des données polygones d’un plan géographique tel qu’une ville ou une région de pays.
SearchGetPolygonDefaultResponse

L’API Get Polygon est une requête HTTP GET qui fournit des données polygones d’un plan géographique tel qu’une ville ou une région de pays.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response

L’API Get Reverse Geocoding est une requête http GET utilisée pour traduire une coordonnée (exemple : 37.786505, -122.3862) en adresse postale compréhensible par l’homme. Utile dans le suivi des applications où vous recevez un flux GPS de l’appareil ou de la ressource et souhaitez connaître l’adresse associée aux coordonnées. Ce point de terminaison retourne les informations d’adresse d’une coordonnée donnée.
SearchGetReverseGeocodingBatch200Response

L’API Get Reverse Geocoding Batch est une requête HTTP POST qui envoie des lots allant jusqu’à 100 requêtes pour géocodage inverse API à l’aide d’une seule requête.

Envoyer une demande de traitement par lots synchrone

L’API synchrone est recommandée pour les requêtes par lots légères. Lorsque le service reçoit une demande, il répond dès que les éléments de lot sont calculés et il n’y aura aucune possibilité de récupérer les résultats ultérieurement. L’API synchrone retourne une erreur de délai d’expiration (réponse 408) si la requête prend plus de 60 secondes. Le nombre d’éléments de lot est limité à 100 pour cette API.

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

Corps POST pour la requête Batch

Pour envoyer le géocodage inverse requêtes, vous utiliserez une requête POST où le corps de la requête contiendra le tableau batchItems au format json et l’en-tête Content-Type sera défini sur application/json. Voici un exemple de corps de requête contenant 2 géocodage inverse requêtes :

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

Un géocodage inverse objet batchItem peut accepter l’un des paramètres de géocodage inverse pris en charged’URI.

Le lot doit contenir au moins 1 requête.

Modèle de réponse par lot

La réponse par lot contient un composant summary qui indique les totalRequests qui faisaient partie de la demande de lot d’origine et successfulRequests c’est-à-dire les requêtes qui ont été exécutées avec succès. La réponse par lot inclut également un tableau batchItems qui contient une réponse pour chaque requête dans la requête de lot. Les batchItems contiennent les résultats dans le même ordre que les requêtes d’origine ont été envoyées dans la requête de lot. Chaque élément est de l’un des types suivants :

  • GeocodingResponse : si la requête s’est terminée correctement.

  • Error : si la requête a échoué. La réponse contient une code et une message dans ce cas.
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse

L’API Get Reverse Geocoding Batch est une requête HTTP POST qui envoie des lots allant jusqu’à 100 requêtes pour géocodage inverse API à l’aide d’une seule requête.

Envoyer une demande de traitement par lots synchrone

L’API synchrone est recommandée pour les requêtes par lots légères. Lorsque le service reçoit une demande, il répond dès que les éléments de lot sont calculés et il n’y aura aucune possibilité de récupérer les résultats ultérieurement. L’API synchrone retourne une erreur de délai d’expiration (réponse 408) si la requête prend plus de 60 secondes. Le nombre d’éléments de lot est limité à 100 pour cette API.

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

Corps POST pour la requête Batch

Pour envoyer le géocodage inverse requêtes, vous utiliserez une requête POST où le corps de la requête contiendra le tableau batchItems au format json et l’en-tête Content-Type sera défini sur application/json. Voici un exemple de corps de requête contenant 2 géocodage inverse requêtes :

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

Un géocodage inverse objet batchItem peut accepter l’un des paramètres de géocodage inverse pris en charged’URI.

Le lot doit contenir au moins 1 requête.

Modèle de réponse par lot

La réponse par lot contient un composant summary qui indique les totalRequests qui faisaient partie de la demande de lot d’origine et successfulRequests c’est-à-dire les requêtes qui ont été exécutées avec succès. La réponse par lot inclut également un tableau batchItems qui contient une réponse pour chaque requête dans la requête de lot. Les batchItems contiennent les résultats dans le même ordre que les requêtes d’origine ont été envoyées dans la requête de lot. Chaque élément est de l’un des types suivants :

  • GeocodingResponse : si la requête s’est terminée correctement.

  • Error : si la requête a échoué. La réponse contient une code et une message dans ce cas.
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse

L’API Get Reverse Geocoding est une requête http GET utilisée pour traduire une coordonnée (exemple : 37.786505, -122.3862) en adresse postale compréhensible par l’homme. Utile dans le suivi des applications où vous recevez un flux GPS de l’appareil ou de la ressource et souhaitez connaître l’adresse associée aux coordonnées. Ce point de terminaison retourne les informations d’adresse d’une coordonnée donnée.
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Alias de type

GeoJsonFeatureOutput

Type d’objet GeoJSON Feature valide. Pour plus d’informations, reportez-vous à RFC 7946.
GeoJsonGeometryOutput

Objet geometry GeoJSON valide. Le type doit être l’un des sept types de géométrie GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, reportez-vous à RFC 7946.
GeoJsonObjectOutput

Objet GeoJSON valide. Pour plus d’informations, reportez-vous à RFC 7946.
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

Functions

default(AzureKeyCredential, ClientOptions)

Crée une instance de MapsSearchClient à partir d’une clé d’abonnement.

Exemple

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)

Crée une instance de MapsSearch à partir d’une TokenCredentiald’identité Azure.

Exemple

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)

Crée une instance de MapsSearch à partir d’une AzureSASCredentiald’identité Azure.

Exemple

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)

Informations relatives à la fonction

default(AzureKeyCredential, ClientOptions)

Crée une instance de MapsSearchClient à partir d’une clé d’abonnement.

Exemple

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

Paramètres

credential
AzureKeyCredential

Instance AzureKeyCredential utilisée pour authentifier les demandes auprès du service

options
ClientOptions

Options utilisées pour configurer le client de recherche

Retours

MapsSearchClient

default(TokenCredential, string, ClientOptions)

Crée une instance de MapsSearch à partir d’une TokenCredentiald’identité Azure.

Exemple

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

Paramètres

credential
TokenCredential

Instance TokenCredential utilisée pour authentifier les demandes auprès du service

mapsAccountClientId

string

ID client Azure Maps d’une ressource de carte spécifique

options
ClientOptions

Options utilisées pour configurer le client de recherche

Retours

MapsSearchClient

default(AzureSASCredential, ClientOptions)

Crée une instance de MapsSearch à partir d’une AzureSASCredentiald’identité Azure.

Exemple

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

Paramètres

credential
AzureSASCredential

Instance AzureSASCredential utilisée pour authentifier les demandes auprès du service

options
ClientOptions

Options utilisées pour configurer le client de recherche

Retours

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Paramètres

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

Retours

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Paramètres

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

Retours

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse) 

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Paramètres

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

Retours

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Paramètres

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

Retours

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Paramètres

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

Retours

response