Search - Get Geocode Autocomplete
Permet d’obtenir une liste classée d’entités suggérées en fonction de l’emplacement d’un utilisateur et d’une requête partielle.
Étant donné une requête avec la localisation d'un utilisateur et une requête partielle servant de préfixe à une chaîne de requête complète (appelée préfixe de requête), l'API Autocomplétion Azure Maps renvoie une liste d'entités suggérées que l'utilisateur recherche le plus probablement. Ces entités sont classées de la plus probable à la moins probable.
GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query={query}
GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query={query}&coordinates={coordinates}&bbox={bbox}&top={top}&resultTypeGroups={resultTypeGroups}&resultTypes={resultTypes}&view={view}&countryRegion={countryRegion}
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Le nom d’hôte du service Azure Maps. Utilisez |
|
api-version
|
query | True |
string minLength: 1 |
Version de l’API à utiliser pour cette opération. |
|
query
|
query | True |
string |
Obligatoire. Préfixe de requête de l’utilisateur. Exemple : « 1 Micro » ou « Muir Woods ». |
|
bbox
|
query |
number[] |
Obligatoire lorsqu’il Exemple : lon1,lat1,lon2,lat2. Taille minimale d’environ 0,00001 degré (~1,1 mètre) Taille maximale : jusqu’à l’étendue globale complète (-180,-90 à 180,90) |
|
|
coordinates
|
query |
number[] |
Obligatoire lorsqu’il
Note: |
|
|
country
|
query |
string |
Signal pour le résultat de la saisie semi-automatique vers un code de région/pays ISO 3166-1 Alpha-2 spécifié, par exemple FR. Seuls les résultats dans le pays/la région spécifiés seront renvoyés. |
|
|
result
|
query |
Liste des groupes de types d’entités renvoyés, séparés par des virgules. Les valeurs possibles sont les suivantes :
|
||
|
result
|
query |
Liste des types d’entités renvoyés, séparés par des virgules. Lorsque le groupe de types est défini sur Adresse, les types pris en charge sont les suivants :
Tous les autres types appartiennent au groupe de types Lieu. Il peut s’agir d’entités telles que AdminDivision1, Neighborhood, PopulatedPlace, etc. La valeur par défaut correspond à tous les types d’entités possibles. |
||
|
top
|
query |
integer (int32) minimum: 1maximum: 20 |
Nombre maximal de réponses qui seront retournées. Par défaut : 5, minimum : 1 et maximum : 20. |
|
|
view
|
query |
string |
Une chaîne qui représente un code de région/pays ISO 3166-1 Alpha-2. Cela modifie les bordures et étiquettes contestées géopolitiques pour s’aligner sur la région utilisateur spécifiée. Par défaut, le paramètre View est défini sur « Auto », même si vous ne l’avez pas défini dans la requête. Reportez-vous à vues prises en charge pour plus d’informations et pour afficher les vues disponibles. |
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Précise quel compte est destiné à être utilisé en conjonction avec le modèle de sécurité Azure AD. Il représente un ID unique pour le compte Azure Maps et peut être récupéré depuis l’API de compte Azure Maps Management Plane. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, voir Gérer l’authentification dans Azure Maps. |
|
| Accept-Language |
string |
Langue dans laquelle les résultats de recherche doivent être retournés. Pour plus d’informations, consultez langues prises en charge. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
La demande a réussi. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Réponse d’erreur inattendue. Media Types: "application/geo+json", "application/json" En-têtes x-ms-error-code: string |
Sécurité
AadToken
Ce sont les flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès basé sur Azure par rôle, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès basés sur les rôles Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes ou sous-ressources de ressources Azure Maps. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.
Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.
Note
- Cette définition de sécurité nécessite l’utilisation de l’en-tête
x-ms-client-idpour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps. - La
Authorization URLest spécifique à l’instance de cloud public Azure. Les clouds souverains disposent d’URL d’autorisation uniques et de configurations d’identifiants Microsoft Entra ID. - Le contrôle d’accès en fonction du rôle Azure est configuré à partir de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
- L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
- Pour plus d’informations sur la plateforme d’identités Microsoft, consultez vue d’ensemble de la plateforme d’identités Microsoft.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
| Nom | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Il s’agit d’une clé partagée provisionnée lorsque vous créer un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, CLI, sdk Azure ou API REST.
Avec cette clé, toute application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elles sont émises.
Pour les applications exposées publiquement, nous vous recommandons d’utiliser les applications clientes confidentielles approche permettant d’accéder aux API REST Azure Maps afin que votre clé puisse être stockée en toute sécurité.
Type:
apiKey
Dans:
header
SAS Token
Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, azure SDK ou LES API REST.
Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.
Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.
Type:
apiKey
Dans:
header
Exemples
Autocomplete API call to search for '1 Microsoft'
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft&coordinates=-122.136833,47.642282
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"streetNumber": "1",
"streetName": "Microsoft Way",
"addressLine": "1 Microsoft Way",
"formattedAddress": "1 Microsoft Way, Redmond, WA 98052, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"streetNumber": "1",
"streetName": "Microsoft West Campus Rd",
"addressLine": "1 Microsoft West Campus Rd",
"formattedAddress": "1 Microsoft West Campus Rd, Redmond, WA, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Charlotte",
"adminDistricts": [
{
"name": "North Carolina",
"shortName": "NC"
},
{
"name": "Mecklenburg"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"streetNumber": "1",
"streetName": "Microsoft Way",
"addressLine": "1 Microsoft Way",
"formattedAddress": "1 Microsoft Way, Charlotte, NC, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Reading",
"adminDistricts": [
{
"name": "England"
},
{
"name": "Reading"
}
],
"countryRegion": {
"ISO": "GB",
"name": "United Kingdom"
},
"streetNumber": "1",
"streetName": "Microsoft Campus",
"addressLine": "1 Microsoft Campus",
"formattedAddress": "1 Microsoft Campus, Earley, Reading, England, United Kingdom"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Sonning",
"adminDistricts": [
{
"name": "England"
},
{
"name": "Reading"
}
],
"countryRegion": {
"ISO": "GB",
"name": "United Kingdom"
},
"streetNumber": "1",
"streetName": "Microsoft Campus",
"addressLine": "1 Microsoft Campus",
"formattedAddress": "1 Microsoft Campus, Sonning, England, United Kingdom"
}
}
}
]
}
Autocomplete API call to search for '1 Microsoft Way, Redmond', filtered by roadblock resultTypes, place resultTypeGroups, and return empty result
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft Way, Redmond&coordinates=-113.301894,49.201888&resultTypeGroups=Place&resultTypes=RoadBlock
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": []
}
Autocomplete API call to search for '15010 NE 36th St WA'
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=15010 NE 36th St WA&coordinates=-122.13704445129011,47.642303642565686&top=5
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"streetNumber": "15010",
"streetName": "NE 36th St",
"addressLine": "15010 NE 36th St",
"formattedAddress": "15010 NE 36th St, Redmond, WA 98052, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Bellevue",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98007",
"streetNumber": "15010",
"streetName": "NE 36th St",
"addressLine": "15010 NE 36th St",
"formattedAddress": "15010 NE 36th St, Bellevue, WA 98007, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Sammamish",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98074",
"streetNumber": "15010",
"streetName": "NE 36th St",
"addressLine": "15010 NE 36th St",
"formattedAddress": "15010 NE 36th St, Sammamish, WA 98074, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Yarrow Point",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98004",
"streetNumber": "15010",
"streetName": "NE 36th St",
"addressLine": "15010 NE 36th St",
"formattedAddress": "15010 NE 36th St, Yarrow Point, WA 98004, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"locality": "Seattle",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98105",
"streetNumber": "15010",
"streetName": "NE 36th St",
"addressLine": "15010 NE 36th St",
"formattedAddress": "15010 NE 36th St, Seattle, WA 98105, United States"
}
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by park and populated place resultTypes, place resultTypeGroups
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place&resultTypes=Park,PopulatedPlace
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "PopulatedPlace",
"address": {
"locality": "Muir Woods",
"adminDistricts": [
{
"name": "Georgia"
},
{
"name": "Fulton County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "30349",
"formattedAddress": "Muir Woods, Georgia 30349, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "Park",
"address": {
"adminDistricts": [
{
"name": "California"
},
{
"name": "Marin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "California"
},
"name": "Muir Woods National Park"
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by park resultTypes
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypes=Park
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "Park",
"address": {
"adminDistricts": [
{
"name": "California"
},
{
"name": "Marin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "California"
},
"name": "Muir Woods National Monument"
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by place resultTypeGroups
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "Forest",
"address": {
"adminDistricts": [
{
"name": "Wisconsin"
},
{
"name": "Dane County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "Wisconsin"
},
"name": "Muir Woods"
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "PopulatedPlace",
"address": {
"locality": "Muir Woods",
"adminDistricts": [
{
"name": "Georgia"
},
{
"name": "Fulton County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "30349",
"formattedAddress": "Muir Woods, Georgia 30349, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "Park",
"address": {
"adminDistricts": [
{
"name": "California"
},
{
"name": "Marin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "California"
},
"name": "Muir Woods National Monument"
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by roadblock resultTypes, address resultTypeGroups
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address&resultTypes=RoadBlock
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "RoadBlock",
"address": {
"streetName": "Muir St",
"addressLine": "Muir St",
"locality": "Grosse Pointe Farms",
"adminDistricts": [
{
"name": "Michigan"
},
{
"name": "Wayne County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "48236",
"formattedAddress": "Muir St, Grosse Pointe Farms, Michigan 48236, United States"
}
}
}
]
}
Définitions
| Nom | Description |
|---|---|
| Address |
L’adresse d’un emplacement suggéré par géocodage ou autocomplétion, analysé en champs structurés.
La rareté est normale : seuls les champs fournis par l’entité résolue sont peuplés. Par exemple, |
|
Address |
Un lotissement administratif contenant une adresse. Par exemple, un État, une province ou un comté. Retourné comme une seule entrée dans le tableau parent |
|
Address |
Le pays ou la région contenant l’adresse, identifié par son nom d’affichage et le code pays ISO 3166-1 Alpha-2. L’un ou l’autre champ peut être omis dans une réponse donnée. |
|
Autocomplete |
Une seule entrée dans le |
|
Autocomplete |
La |
|
Autocomplete |
Le corps de réponse réussi a répondu par |
|
Autocomplete |
Une classification des suggestions d’autocomplétion utilisées à la fois |
|
Autocomplete |
Une classification grossière d’une suggestion d’autocomplétion en l’un des deux groupes. Utilisé à la fois |
|
Azure. |
Objet d’erreur. |
|
Azure. |
Réponse contenant les détails de l’erreur. |
|
Azure. |
Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Feature |
Le type d’objet |
|
Feature |
Le type d’objet |
|
Geo |
Spécifie le type |
|
Geo |
Type de géométrie |
| Intersection |
Les détails de l’intersection d’une adresse sont définis comme un intersection routière — le coin où deux rues nommées ou plus se rejoignent. Rempli uniquement lorsque l’entité résolue est un |
Address
L’adresse d’un emplacement suggéré par géocodage ou autocomplétion, analysé en champs structurés.
La rareté est normale : seuls les champs fournis par l’entité résolue sont peuplés. Par exemple, streetName et streetNumber apparaissent uniquement pour les adresses au niveau de la rue, et intersection apparaissent uniquement pour les résultats d’intersections routières.
| Nom | Type | Description |
|---|---|---|
| addressLine |
string |
La première ligne de l’adresse, généralement le nom et le numéro de la rue. Par exemple : |
| adminDistricts |
Les subdivisions administratives qui contiennent l’adresse, classées du plus grossier au plus raffiné. La première entrée est généralement la subdivision de premier ordre (comme un État américain ou une province canadienne) ; Les entrées suivantes couvrent les divisions plus fines où le pays, la dépendance ou la région les définit (comme un comté à l’index 1). |
|
| countryRegion |
Le pays ou la région contenant l’adresse, avec son nom d’affichage et le code pays ISO 3166-1 Alpha-2. |
|
| formattedAddress |
string |
L’adresse complète est rendue sous forme d’une seule chaîne lisible par l’homme, les composantes étant reliées selon les conventions du pays ou de la région de l’adresse. Exemple : |
| intersection |
Les détails des rues qui se croisent pour l’adresse, sont remplis lorsque l’entité résolue est un |
|
| locality |
string |
La localité dans laquelle se situe l’adresse : généralement une ville, un village ou une ville. Par exemple : |
| neighborhood |
string |
Le quartier nommé dans la localité, lorsqu’un est identifié. |
| postalCode |
string |
Le code postal de l’adresse, lorsqu’une est définie. Exemple : |
| streetName |
string |
La composante nom de rue de l’adresse, lorsque l’entité résolue est une adresse au niveau de la rue. Exemple : |
| streetNumber |
string |
Le numéro de maison ou de bâtiment sur la rue, lorsque l’entité résolue est une adresse au niveau de la rue. Exemple : |
AddressAdminDistrictsItem
Un lotissement administratif contenant une adresse. Par exemple, un État, une province ou un comté. Retourné comme une seule entrée dans le tableau parent Address.adminDistricts , où les entrées sont ordonnées du plus grossier au plus fin.
| Nom | Type | Description |
|---|---|---|
| name |
string |
Le nom complet du lotissement. Par exemple, |
| shortName |
string |
La forme abrégée ou abrégée du nom de la subdivision, lorsque l’on en définit. Par exemple, |
AddressCountryRegion
Le pays ou la région contenant l’adresse, identifié par son nom d’affichage et le code pays ISO 3166-1 Alpha-2. L’un ou l’autre champ peut être omis dans une réponse donnée.
| Nom | Type | Description |
|---|---|---|
| ISO |
string |
Le code pays ISO 3166-1 Alpha-2 pour le pays ou la région. Par exemple, |
| name |
string |
Le nom affiché du pays ou de la région. Par exemple : |
AutocompleteFeature
Une seule entrée dans le features tableau d’un AutocompleteResponse, conforme à la forme de l’objet GeoJSON Feature .
Représente une suggestion d’autocomplétion : classification (type, typeGroup), adresse analysée et nom de lieu optionnel sont exposés via properties, avec une coordonnée représentative indiquant geometry quand un nom est disponible.
| Nom | Type | Description |
|---|---|---|
| geometry |
La coordonnée de la suggestion d’autocomplétion est un |
|
| properties |
Données structurées sur la suggestion d’autocomplétion, y compris sa classification, son adresse analysée, et (pour |
|
| type |
Le type d’objet |
AutocompleteProperties
La properties charge utile d’un AutocompleteFeaturefichier . Porte la classification du résultat (typeGroup, type), son adresse analysée, et (pour de nombreux Placerésultats -typés) un nom d’affichage distinct.
| Nom | Type | Description |
|---|---|---|
| address |
L’adresse du résultat d’autocomplétion, analysée en champs structurés.
|
|
| name |
string |
Le nom d’affichage de l’endroit suggéré. Rempli pour les |
| type |
Le type d’entité spécifique auquel le résultat se résout. Par exemple, une adresse, un lieu peuplé, un parc ou un monument. Voir |
|
| typeGroup |
La classification large du résultat en tant qu’adresse ou lieu nommé. Voir |
AutocompleteResponse
Le corps de réponse réussi a répondu par Get Autocomplete. Encodé comme un GeoJSON FeatureCollection tableau dont features contient un Feature par suggestion d’autocomplétion, classé du plus au moins probable.
| Nom | Type | Description |
|---|---|---|
| features |
Le tableau des |
|
| nextLink |
string |
Contient l’URL pour récupérer la page suivante de résultats si la réponse est paginanée. Cela est utile lorsque la réponse est trop importante pour être retournée en un seul appel, permettant aux utilisateurs de naviguer à travers plusieurs pages de résultats. |
| type |
Le type d’objet |
AutocompleteResultTypeEnum
Une classification des suggestions d’autocomplétion utilisées à la fois Get Autocomplete comme filtre d’entrée (via le resultTypes paramètre de requête) et comme étiquette de sortie (via le type champ sur chaque AutocompleteProperties). Les membres définissent une taxonomie de type gazetteer couvrant adresses, segments de route, régions administratives, lieux peuplés, caractéristiques naturelles et points d’intérêt. Cette taxonomie est divisée en deux groupes plus larges par AutocompleteResultTypeGroupsEnum: Address, qui couvre les adresses et les segments de route ; et Place, qui couvre tous les autres types de résultats.
| Valeur | Description |
|---|---|
| Address |
Une adresse précise. |
| AdminDivision1 |
Premier niveau administratif au sein du pays ou de la région, comme un État ou une province. |
| AdminDivision2 |
Deuxième niveau administratif au sein du pays/région, comme un comté. |
| AdminDivision3 |
Troisième niveau administratif au sein du pays ou de la région, tel qu’un district, une paroisse ou une municipalité. |
| AdministrativeBuilding |
Un bâtiment qui abrite des bureaux gouvernementaux ou des fonctions administratives publiques. |
| Airport |
Une installation où les avions décollent et atterrissent régulièrement, avec des installations pour passagers et fret. |
| AirportTerminal |
Un terminal passagers à l’intérieur d’un aéroport. |
| AmusementPark |
Un centre de divertissement avec des manèges, des jeux et des activités thématiques. |
| AncientSite |
Un lieu où sont conservés des vestiges archéologiques ou des artefacts culturels d’une civilisation ancienne. |
| Aquarium |
Un établissement public où des plantes et animaux aquatiques sont exposés et étudiés. |
| Archipelago |
Un groupe ou une chaîne d’îles. |
| Basin |
Une dépression naturelle à la surface du sol, souvent entourée de terrains plus élevés. |
| Battlefield |
Un lieu d’une bataille terrestre d’importance historique. |
| Bay |
Un plan d’eau partiellement enfermé par la terre, plus petit qu’un golfe et plus grand qu’une crique. |
| Beach |
Une rive de sable, de galets ou d’autres sédiments non consolidés le long d’un plan d’eau. |
| Bridge |
Une structure portant une route, une voie ferrée ou un chemin de fer traversant un obstacle tel qu’une rivière, une vallée ou une autre route. |
| BusinessStructure |
Un bâtiment utilisé pour des activités commerciales ou commerciales générales qui ne correspond pas à une catégorie plus spécifique. |
| Camp |
Un site avec des abris ou des installations pour une occupation temporaire, comme un terrain de camping ou un établissement saisonnier. |
| Canal |
Un cours d’eau artificiel utilisé pour le transport, l’irrigation ou le drainage. |
| Casino |
Une installation utilisée pour les jeux d’argent et les jeux de hasard. |
| Castle |
Un bâtiment ou un complexe historiquement fortifié, généralement associé à une résidence noble ou royale. |
| Cave |
Une chambre ou passage souterrain naturel formé dans la roche. |
| Cemetery |
Un lieu de sépulture ou un cimetière. |
| Channel |
Un cours d’eau navigable entre deux masses terrestres ou le principal chemin d’écoulement d’un grand plan d’eau. |
| Church |
Un bâtiment utilisé pour le culte chrétien public. |
| Cliff |
Une face haute et escarpée de roche ou de terre, souvent surplombant une côte ou une vallée. |
| Coast |
Une étendue de terre nommée bordant la mer. |
| CommunityCenter |
Un établissement accueillant des activités communautaires, des réunions et des services sociaux. |
| Continent |
L’une des principales masses terrestres de la Terre. |
| CountryRegion |
Un pays ou une région. |
| Crater |
Une dépression circulaire formée par une activité volcanique ou un impact de météorite. |
| CulturalRegion |
Une zone distinguée par des caractéristiques culturelles communes, telles que la langue, l’ethnie ou le patrimoine. |
| Dam |
Une barrière construite au-dessus d’un ruisseau ou d’une rivière pour retenir l’eau. |
| Delta |
Une formation de relief de dépôts alluviaux s’est formée là où une rivière rencontre un plan d’eau plus vaste. |
| Desert |
Une grande région aride avec une végétation clairsemée en raison de précipitations limitées. |
| DrainageBasin |
Une zone de terre drainée par un système fluvial et ses affluents. |
| Dune |
Un monticule ou une crête de sable soufflé par le vent. |
| FacilityStructure |
Une structure qui abrite une installation spécialisée, telle qu’une centrale électrique ou une installation de service. |
| FerryTerminal |
Une installation où passagers et véhicules embarquent et descendent des ferries. |
| FinancialStructure |
Un bâtiment abritant une banque, une coopérative de crédit ou un autre établissement de services financiers. |
| FireStation |
Un bâtiment qui abrite les pompiers, le matériel et les véhicules d’intervention d’urgence. |
| Forest |
Une vaste zone de terrain dominée par des arbres. |
| Fort |
Une structure militaire défensive ou des ouvrages de terre. |
| Garden |
Un espace cultivé pour exposer des plantes ornementales ou des plantes scientifiquement sélectionnées. |
| Geyser |
Une source chaude qui fait périodiquement érupter des jets d’eau et de vapeur. |
| Glacier |
Une masse persistante de glace qui se déplace lentement sous son propre poids. |
| GolfCourse |
Un terrain aménagé pour jouer au golf. |
| GreaterPopulatedPlace |
Une zone métropolitaine ou une agglomération qui contient et s’étend au-delà d’un lieu habité. |
| HigherEducationFacility |
Un collège, une université ou un établissement similaire d’enseignement postsecondaire. |
| HistoricalSite |
Un site d’importance historique, souvent préservé comme site du patrimoine culturel. |
| Hospital |
Un établissement médical offrant des soins hospitaliers et ambulatoires. |
| HotSpring |
Une source naturelle où émerge à la surface de l’eau souterraine chauffée géothermiquement. |
| Ice |
Une masse naturelle ou une couche superficielle d’eau gelée recouvrant la terre ou l’eau. |
| IndigenousPeoplesReserve |
Un territoire reconnu comme la patrie d’un peuple ou d’une communauté autochtone. |
| IndustrialStructure |
Un bâtiment ou une installation utilisé pour la fabrication, la production ou d’autres opérations industrielles. |
| Island |
Une masse terrestre entourée d’eau, plus petite qu’un continent. |
| Isthmus |
Une étroite bande de terre reliant deux grandes masses terrestres et séparant deux plans d’eau. |
| Lake |
Un plan d’eau stagnante à l’intérieur des terres entouré de terres. |
| LandArea |
Une région terrestre nommée qui ne correspond pas à une catégorie géographique plus spécifique. |
| Landform |
Une caractéristique naturelle du terrain qui ne correspond pas à une catégorie plus spécifique, comme un |
| LandmarkBuilding |
Un bâtiment remarquable d’importance architecturale, culturelle ou historique, qui sert de point de repère reconnaissable. |
| Library |
Un bâtiment abritant une collection de livres et d’autres supports accessibles au public. |
| Lighthouse |
Une structure côtière ou portuaire affichant un feu de navigation pour guider les navires. |
| Marina |
Une installation portuaire fournissant des mouillages et des services pour les petites embarcations et yachts. |
| Market |
Un endroit où les biens sont achetés et vendus, généralement au détail. |
| MedicalStructure |
Un bâtiment utilisé pour des services médicaux ou liés à la santé autres qu’un |
| MetroStation |
Une station sur un réseau de métro, de métro ou d’un autre réseau urbain de transport rapide. |
| MilitaryBase |
Une installation exploitée par les forces armées pour la formation, l’approvisionnement ou les opérations. |
| Mission |
Un complexe géré par un groupe religieux pour fournir des services communautaires et propager la foi. |
| Monument |
Une structure commémorative ou une statue érigée pour honorer une personne, un événement ou une idée. |
| Mosque |
Un bâtiment utilisé pour le culte islamique public. |
| Mountain |
Un relief, qui s’élève nettement au-dessus de son environnement, généralement avec des pentes abruptes et un sommet bien défini. |
| MountainRange |
Une série reliée de montagnes formant une chaîne continue. |
| MultiModalStation |
Une gare qui dessert plusieurs modes de transport, tels que les trains combinés, les bus ou le métro. |
| Museum |
Un établissement où des objets d’intérêt artistique, scientifique ou historique sont préservés et exposés. |
| NauticalStructure |
Une structure liée à une activité maritime ou nautique, telle qu’une jetée, un quai ou une bouée. |
| Neighborhood |
Une zone reconnue localement au sein d’un lieu peuplé, souvent avec des limites informelles ou culturellement définies. |
| Oasis |
Une zone fertile dans un désert soutenue par une source d’eau naturelle. |
| ObservationPoint |
Un point de vue ou un belvédère offrant des vues panoramiques sur les environs. |
| Ocean |
L’une des principales divisions de l’océan mondial de la Terre. |
| OfficeBuilding |
Un bâtiment principalement utilisé comme espace professionnel ou administratif. |
| Other |
Une suggestion qui ne correspond à aucun autre type défini. |
| Park |
Un espace entretenu pour les loisirs publics ou les divertissements pittoresques. |
| ParkingStructure |
Une structure à plusieurs niveaux dédiée au stationnement des véhicules. |
| Pass |
Un itinéraire navigable à travers ou au-dessus d’une chaîne de montagnes ou d’un obstacle similaire. |
| Peninsula |
Une masse terrestre s’avançant dans un plan d’eau et presque entourée par celle-ci. |
| Plain |
Une vaste zone de terrain relativement plat ou doucement ondulé. |
| Planet |
Un corps céleste en orbite autour d’une étoile, généralement utilisé pour représenter la Terre comme racine de la hiérarchie géographique. |
| Plateau |
Une zone surélevée de terrain relativement plat avec des pentes abruptes sur un ou plusieurs côtés. |
| Playground |
Une zone de loisirs aménagée pour les jeux des enfants. |
| PlayingField |
Un espace ouvert utilisé pour la pratique de sports organisés. |
| Pole |
Un pôle géographique, comme le pôle Nord ou le pôle Sud. |
| PoliticalUnit |
Une entité politique autonome, telle qu’un État ou un territoire indépendant ou dépendant. |
| PopulatedPlace |
Zone concentrée d’établissements humains, telle qu’une ville, une ville ou un village. |
| Port |
Une installation maritime avec des terminaux pour le chargement et le déchargement de marchandises ou passagers par voie d’eau. |
| Postcode1 |
La plus petite catégorie de code postal, comme un code postal. |
| Promontory |
Une forme de relief surélevée proéminente s’avançant dans une plaine ou un plan d’eau. |
| RaceTrack |
Un circuit ou un parcours conçu pour les véhicules de course, les animaux ou les athlètes. |
| RailwayStation |
Une installation où les passagers montent et descendent des trains. |
| Reef |
Une crête submergée ou partiellement submergée de roche, de sable ou de corail près de la surface de l’eau. |
| ReligiousStructure |
Un bâtiment utilisé pour le culte ou la pratique religieuse qui ne correspond pas à une catégorie plus spécifique, comme |
| Reserve |
Un terrain protégé réservé à la conservation, à la faune ou à d’autres usages restreints. |
| ResidentialStructure |
Un bâtiment principalement utilisé pour la résidence humaine, comme un immeuble ou un complexe résidentiel. |
| River |
Un cours d’eau naturel s’écoulant vers une altitude plus basse, généralement vers une mer, un lac ou une autre rivière. |
| RoadBlock |
Un segment de rue sans numéro de maison spécifique, retourné lorsque le service de géocodage ne parvient pas à localiser un numéro de maison exact pour la requête. Malgré son nom, cette valeur n’indique pas une fermeture physique de la route. |
| Ruin |
Une structure détruite ou en ruine qui ne remplit plus sa fonction d’origine. |
| ScientificResearchBase |
Une installation utilisée comme base pour la recherche scientifique, souvent dans des environnements isolés ou extrêmes. |
| Sea |
Un grand plan d’eau salée partiellement enfermé par la terre, plus petit qu’un océan. |
| SeaplaneLandingArea |
Une zone d’eau destinée au décollage et à l’atterrissage des hydravions. |
| Shrine |
Une structure ou un lieu qui commémore une personne ou commémore un événement ou un concept sacré. |
| SkiArea |
Une aire de loisirs aménagée pour le ski et d’autres sports d’hiver. |
| Spring |
Une source naturelle où l’eau souterraine s’écoule de la surface de la terre. |
| Stadium |
Un grand lieu avec des places en gradins pour les sports ou événements de spectateurs. |
| StatisticalDistrict |
Une région définie à des fins statistiques ou de recensement, comme une aire statistique métropolitaine ou un secteur de recensement. |
| Temple |
Un bâtiment dédié au culte religieux. |
| Theater |
Un lieu pour présenter des pièces de théâtre, des films ou d’autres représentations en direct ou enregistrées. |
| TouristRailway |
Un chemin de fer pittoresque ou patrimonial exploitait principalement le tourisme plutôt que le transport en commun. |
| TouristStructure |
Un bâtiment qui accueille les touristes, comme un centre d’accueil ou un bureau d’information touristique. |
| Trailhead |
Le point de départ d’un sentier de randonnée, de vélo ou de loisirs. |
| TransportationStructure |
Une structure qui soutient les infrastructures de transport, telles qu’un poste de péage, une station de pesée ou un abri de transport. |
| Tunnel |
Un passage souterrain ou sous-marin pour le transport routier, ferroviaire ou piétonnier. |
| Valley |
Une zone basse allongée entre collines ou montagnes, souvent contenant un cours d’eau. |
| Volcano |
Une montagne ou une colline formée par une activité volcanique, généralement avec un cratère à son sommet. |
| Walkway |
Un chemin ou une surface pavée destinée à l’usage piétonnier. |
| Wall |
Une barrière construite formant une frontière verticale continue, souvent utilisée pour la défense, la séparation ou la commémoration. |
| Waterfall |
Un point où un ruisseau ou une rivière descend verticalement ou abruptement. |
| WaterFeature |
Un plan d’eau qui ne correspond pas à une catégorie plus spécifique, comme un |
| Wetland |
Une zone de terre saturée d’eau et abritant une végétation aquatique, comme un marais ou un marécage. |
| Winery |
Un établissement où le vin est produit et souvent proposé à la dégustation ou à la vente. |
| Zoo |
Un établissement où les animaux sauvages sont gardés pour exposition publique et étude. |
AutocompleteResultTypeGroupsEnum
Une classification grossière d’une suggestion d’autocomplétion en l’un des deux groupes. Utilisé à la fois Get Autocomplete comme filtre d’entrée via le resultTypeGroups paramètre de requête (restreignant les types de suggestions retournées) et comme classificateur de sortie via le typeGroup champ de chacun AutocompleteProperties (identifiant à quel groupe appartient une suggestion retournée). Le Address groupe couvre les adresses individuelles et les segments de rue ; il Place couvre tous les autres types d’entités (régions administratives, lieux peuplés, caractéristiques naturelles et points d’intérêt).
| Valeur | Description |
|---|---|
| Address |
Des suggestions qui se résument à une adresse précise ou à un segment de route. |
| Place |
Des suggestions qui se résument à des lieux nommés, incluant les régions administratives, les lieux habités, les quartiers, les caractéristiques naturelles et les points d’intérêt. Exemples : , |
Azure.Core.Foundations.Error
Objet d’erreur.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Un ensemble de codes d’erreur définis par le serveur. |
| details |
Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée. |
|
| innererror |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
|
| message |
string |
Représentation lisible par l’homme de l’erreur. |
| target |
string |
Cible de l’erreur. |
Azure.Core.Foundations.ErrorResponse
Réponse contenant les détails de l’erreur.
| Nom | Type | Description |
|---|---|---|
| error |
Objet d’erreur. |
Azure.Core.Foundations.InnerError
Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Un ensemble de codes d’erreur définis par le serveur. |
| innererror |
Erreur interne. |
FeatureCollectionEnum
Le type d’objet GeoJSON utilisé à la base des réponses réussies issues des opérations de géocodage direct, de géocodage inverse et d’autocomplétion (y compris leurs variantes par lot). La seule valeur est FeatureCollection, telle que définie dans la RFC 7946.
Get Polygon est la seule exception : sa racine de réponse est un GeoJSON Feature, voir FeatureTypeEnum.
| Valeur | Description |
|---|---|
| FeatureCollection |
Le type d’objet |
FeatureTypeEnum
Le type d’objet GeoJSON pour Feature les objets. Étiquete chaque entrée dans le features tableau d’une FeatureCollection réponse (géocodage, géocodage inverse, autocomplétion) et apparaît à la racine de la Get Polygon réponse. La seule valeur est Feature, telle que définie dans la RFC 7946.
| Valeur | Description |
|---|---|
| Feature |
Le type d’objet |
GeoJsonObjectType
Spécifie le type GeoJSON. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.
| Valeur | Description |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
|
| FeatureCollection |
|
GeoJsonPoint
Type de géométrie GeoJSON Point valide. Pour plus d’informations, reportez-vous à RFC 7946.
| Nom | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, reportez-vous à RFC 7946. |
| coordinates |
number[] (double) |
Un |
| type |
string:
Point |
Spécifie le type |
Intersection
Les détails de l’intersection d’une adresse sont définis comme un intersection routière — le coin où deux rues nommées ou plus se rejoignent. Rempli uniquement lorsque l’entité résolue est un RoadIntersection; le parent Address.intersection est autrement omis.
| Nom | Type | Description |
|---|---|---|
| baseStreet |
string |
La rue principale de l’intersection — généralement la rue à laquelle le numéro d’adresse fait référence. |
| displayName |
string |
Un nom lisible par l’humain pour l’intersection qui combine les rues transversales, comme |
| intersectionType |
string |
Une courte étiquette décrivant la forme de l’intersection. Par exemple, distinguer un carrefour à niveau d’un passage à niveau séparé comme un pont ou un viaduc. |
| secondaryStreet1 |
string |
La première rue transversale qui se rejoint |
| secondaryStreet2 |
string |
La deuxième rue transversale à l’intersection, quand il y en a une. Habitée uniquement pour les intersections de trois rues ou plus. |