Search - Get Geocode Autocomplete
Verwenden Sie diese Option, um eine Rangliste der vorgeschlagenen Entitäten basierend auf dem Standort eines Benutzers und einer Teilabfrage abzurufen.
Gegeben eine Anfrage mit dem Standort eines Benutzers und eine teilweise Abfrage, die als Präfix einer vollständigen Abfrage-Zeichenkette dient (als Abfragepräfix bezeichnet), liefert die Azure Maps Autocomplete API eine Liste vorgeschlagener Entitäten, nach denen der Benutzer höchstwahrscheinlich sucht. Diese Entitäten werden von der wahrscheinlichsten bis zur unwahrscheinlichsten eingestuft.
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}
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Der Hostname des Azure Maps-Dienstes. Verwenden Sie |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
|
query
|
query | True |
string |
Erforderlich. Das Abfragepräfix des Benutzers. Beispiel: "1 Micro" oder "Muir Woods". |
|
bbox
|
query |
number[] |
Erforderlich, wenn Beispiel: lon1,lat1,lon2,lat2. Mindestgröße: ca. 0,00001 Grad (~0,01 Meter). Maximale Größe: bis zur vollen globalen Ausdehnung (-180,-90 bis 180,90) |
|
|
coordinates
|
query |
number[] |
Erforderlich, wenn
Anmerkung: |
|
|
country
|
query |
string |
Signal für das Autocomplete-Ergebnis an einen ISO 3166-1 Alpha-2 Region/Ländercode , der z.B. FR angegeben ist. Es werden nur Ergebnisse in dem angegebenen Land/der angegebenen Region zurückgegeben. |
|
|
result
|
query |
Eine durch Kommas getrennte Liste der zurückgegebenen Entitätstypgruppen. Mögliche Werte:
|
||
|
result
|
query |
Eine durch Kommas getrennte Liste der zurückgegebenen Entitätstypen. Wenn type group auf Address festgelegt ist, werden folgende Typen unterstützt:
Alle anderen Typen gehören zur Gruppe Ortstyp. Dazu können Entitäten wie AdminDivision1, Neighborhood, PopulatedPlace und mehr gehören. Der Standardwert sind alle möglichen Entitätstypen. |
||
|
top
|
query |
integer (int32) minimum: 1maximum: 20 |
Maximale Anzahl von Antworten, die zurückgegeben werden. Standardwert: 5, Minimum: 1 und Maximum: 20. |
|
|
view
|
query |
string |
Eine Zeichenfolge, die einen ISO 3166-1 Alpha-2-Regions-/Ländercode darstellt. Dies wird geopolitische umstrittene Grenzen und Bezeichnungen ändern, um sie an die angegebene Benutzerregion auszurichten. Der Parameter "View" ist standardmäßig auf "Auto" festgelegt, auch wenn Sie ihn in der Anforderung nicht definiert haben. Weitere Informationen finden Sie unter Unterstützten Ansichten und die verfügbaren Ansichten. |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| x-ms-client-id |
string |
Spezifiziert, welches Konto für die Nutzung in Verbindung mit dem Azure-AD-Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebene-Account API abgerufen werden. Weitere Informationen zur Nutzung Microsoft Entra ID Sicherheit in Azure Maps finden Sie unter Authentifizierung verwalten in Azure Maps. |
|
| Accept-Language |
string |
Sprache, in der Suchergebnisse zurückgegeben werden sollen. Weitere Informationen finden Sie unter unterstützten Sprachen. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Anforderung ist erfolgreich. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Unerwartete Fehlerantwort. Media Types: "application/geo+json", "application/json" Header x-ms-error-code: string |
Sicherheit
AadToken
Dies sind die Microsoft Entra OAuth 2.0 Flows. In Kombination mit Azure rollenbasierten Zugriffs Steuerung kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Azure-rollenbasierte Zugriffskontrollen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.
Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.
Note
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id-Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-APIerworben werden. - Die
Authorization URList spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über einzigartige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen. - Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
- Die Verwendung des Azure Maps Web SDK ermöglicht das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.
- Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.
Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.
Typ:
apiKey
In:
header
SAS Token
Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.
Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.
Typ:
apiKey
In:
header
Beispiele
Autocomplete API call to search for '1 Microsoft'
Beispielanforderung
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft&coordinates=-113.301894,49.201888
Beispiel für eine Antwort
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"streetNumber": "1",
"streetName": "Microsoft Way",
"addressLine": "1 Microsoft Way",
"locality": "Redmond",
"adminDistricts": [
{
"name": "Washington"
},
{
"name": "King County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"formattedAddress": "1 Microsoft Way, Redmond, Washington 98052, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "LandmarkBuilding",
"address": {
"locality": "Bellevue",
"adminDistricts": [
{
"name": "Washington"
},
{
"name": "King County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "Bellevue, Washington, United States"
},
"name": "Microsoft-Advanta C"
}
}
]
}
Autocomplete API call to search for '1 Microsoft Way, Redmond', filtered by roadblock resultTypes, place resultTypeGroups, and return empty result
Beispielanforderung
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
Beispiel für eine Antwort
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": []
}
Autocomplete API call to search for 'Muir Woods', filtered by address resultTypeGroups
Beispielanforderung
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address
Beispiel für eine Antwort
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "RoadBlock",
"address": {
"locality": "Mill Valley",
"adminDistricts": [
{
"name": "California",
"shortName": "CA"
},
{
"name": "Marin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "94941",
"streetName": "Muir Woods Trail",
"addressLine": "",
"formattedAddress": "Muir Woods Trail, Mill Valley, CA 94941, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "RoadBlock",
"address": {
"locality": "Sausalito",
"adminDistricts": [
{
"name": "California",
"shortName": "CA"
},
{
"name": "Marin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "94965",
"streetName": "Muir Woods Rd",
"addressLine": "",
"formattedAddress": "Muir Woods Rd, Sausalito, CA 94965, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "RoadBlock",
"address": {
"locality": "Las Vegas",
"adminDistricts": [
{
"name": "Nevada",
"shortName": "NV"
},
{
"name": "Clark County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "89122",
"streetName": "Muir Woods Pkwy",
"addressLine": "",
"formattedAddress": "Muir Woods Pkwy, Las Vegas, NV 89122, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "RoadBlock",
"address": {
"locality": "Stockton",
"adminDistricts": [
{
"name": "California",
"shortName": "CA"
},
{
"name": "San Joaquin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "95209",
"streetName": "Muir Woods Ave",
"addressLine": "",
"formattedAddress": "Muir Woods Ave, Stockton, CA 95209, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "RoadBlock",
"address": {
"locality": "Stonington",
"adminDistricts": [
{
"name": "Maine",
"shortName": "ME"
},
{
"name": "Hancock County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "04681",
"streetName": "Muir Woods Rd",
"addressLine": "",
"formattedAddress": "Muir Woods Rd, Stonington, ME 04681, United States"
}
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by park and populated place resultTypes, place resultTypeGroups
Beispielanforderung
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
Beispiel für eine Antwort
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
Beispielanforderung
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypes=Park
Beispiel für eine Antwort
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
Beispielanforderung
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place
Beispiel für eine Antwort
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
Beispielanforderung
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address&resultTypes=RoadBlock
Beispiel für eine Antwort
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"
}
}
}
]
}
Definitionen
| Name | Beschreibung |
|---|---|
| Address |
Die Adresse eines geokodierten oder autokomplett-vorgeschlagenen Ortes, in strukturierte Felder umgewandelt.
Dünnheit ist normal: Nur die Felder, die die aufgelöste Entität bereitstellt, sind gefüllt. Zum Beispiel erscheinen |
|
Address |
Eine Verwaltungsunterteilung, die eine Adresse enthält. Zum Beispiel ein Bundesstaat, eine Provinz oder ein Landkreis. Zurückgegeben als ein Eintrag im Elternarray |
|
Address |
Das Land oder die Region, die die Adresse enthält, identifiziert durch ihren Anzeigenamen und den Ländercode ISO 3166-1 Alpha-2. Beide Felder können in einer gegebenen Antwort ausgelassen werden. |
|
Autocomplete |
Ein einzelner Eintrag im |
|
Autocomplete |
Die Nutzlast |
|
Autocomplete |
Der erfolgreiche Antwortkörper wurde durch zurückgegeben |
|
Autocomplete |
Eine Klassifikation von Autovervollständigungsvorschlägen, die sowohl als |
|
Autocomplete |
Eine grobe Klassifikation eines autokompletten Vorschlags in eine von zwei Gruppen. Wird sowohl als |
|
Azure. |
Das Fehlerobjekt. |
|
Azure. |
Eine Antwort, die Fehlerdetails enthält. |
|
Azure. |
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Laut Azure REST API-Richtlinien – https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Feature |
Der |
|
Feature |
Der |
|
Geo |
Gibt den |
|
Geo |
Ein gültiger |
| Intersection |
Kreuzungsdetails für eine Adresse, die als Straßenkreuzung definiert ist – die Ecke, an der sich zwei oder mehr benannte Straßen treffen. Nur dann gefüllt, wenn die aufgelöste Entität ein |
Address
Die Adresse eines geokodierten oder autokomplett-vorgeschlagenen Ortes, in strukturierte Felder umgewandelt.
Dünnheit ist normal: Nur die Felder, die die aufgelöste Entität bereitstellt, sind gefüllt. Zum Beispiel erscheinen streetName und streetNumber nur für Straßenadressen und intersection nur für Straßenkreuzungsergebnisse.
| Name | Typ | Beschreibung |
|---|---|---|
| addressLine |
string |
Die erste Zeile der Adresse ist typischerweise der Straßenname und die Nummer. Beispiel: |
| adminDistricts |
Die Verwaltungsunterteilungen, die die Adresse enthalten, sind von grob bis feinst geordnet. Der erste Eintrag ist typischerweise die erste Unterteilung (wie ein US-Bundesstaat oder eine kanadische Provinz); Nachfolgende Einträge behandeln feinere Einteilungen, in denen das Land, die Abhängigkeit oder die Region sie definiert (wie zum Beispiel ein Landkreis bei Index 1). |
|
| countryRegion |
Das Land oder die Region, die die Adresse enthält, mit ihrem Anzeigenamen und dem ISO 3166-1 Alpha-2 Ländercode. |
|
| formattedAddress |
string |
Die vollständige Adresse wird als einziger, menschenlesbarer String wiedergegeben, wobei die Komponenten gemäß den Konventionen des Landes oder der Region der Adresse verbunden sind. Beispiel: |
| intersection |
Die sich kreuzenden Straßen sind Angaben zur Adresse, die gefüllt werden, wenn die gelöste Entität ein ist |
|
| locality |
string |
Der Ort, in dem die Adresse liegt, ist meist eine Stadt, ein Ort oder ein Dorf. Beispiel: |
| neighborhood |
string |
Das benannte Viertel innerhalb des Ortes, wenn eines identifiziert wird. |
| postalCode |
string |
Die Postleitzahl der Adresse, wenn eine definiert ist. Beispiel: |
| streetName |
string |
Die Straßennamenkomponente der Adresse, wenn die gelöste Entität eine Straßenadresse ist. Beispiel: |
| streetNumber |
string |
Die Haus- oder Gebäudenummer in der Straße, wenn die gelöste Entität eine Adresse auf Straßenniveau ist. Beispiel: |
AddressAdminDistrictsItem
Eine Verwaltungsunterteilung, die eine Adresse enthält. Zum Beispiel ein Bundesstaat, eine Provinz oder ein Landkreis. Zurückgegeben als ein Eintrag im Elternarray Address.adminDistricts , wobei Einträge von grob bis feinst geordnet sind.
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Der vollständige Name der Siedlung. Zum Beispiel |
| shortName |
string |
Die Kurz- oder Kurzform des Unterteilungsnamens, wenn einer definiert ist. Zum Beispiel |
AddressCountryRegion
Das Land oder die Region, die die Adresse enthält, identifiziert durch ihren Anzeigenamen und den Ländercode ISO 3166-1 Alpha-2. Beide Felder können in einer gegebenen Antwort ausgelassen werden.
| Name | Typ | Beschreibung |
|---|---|---|
| ISO |
string |
Der Ländercode ISO 3166-1 Alpha-2 für das Land oder die Region. Zum Beispiel |
| name |
string |
Der Anzeigename des Landes oder der Region. Beispiel: |
AutocompleteFeature
Ein einzelner Eintrag im features Array eines AutocompleteResponse, der der GeoJSON Feature Objektform entspricht.
Stellt einen Autovervollständigungsvorschlag dar: Klassifikation (type, typeGroup), eine geparste Adresse und ein optionaler Ortsname werden über properties, mit einer repräsentativen Koordinate an, wann geometry einer verfügbar ist.
| Name | Typ | Beschreibung |
|---|---|---|
| geometry |
Die Koordinate der Autovervollständigungsvorschlag als , |
|
| properties |
Strukturierte Daten zum Autocomplete-Vorschlag, einschließlich seiner Klassifikation, geparsteten Adresse und (für |
|
| type |
Der Objekttyp |
AutocompleteProperties
Die Nutzlast properties eines AutocompleteFeature. Trägt die Klassifikation des Ergebnisses (typeGroup, type), seine geparste Adresse und (für viele Place-getypte Ergebnisse) einen separaten Anzeigenamen.
| Name | Typ | Beschreibung |
|---|---|---|
| address |
Die Adresse des Autovervollständigungsergebnisses, in strukturierte Felder umgewandelt.
|
|
| name |
string |
Der Anzeigename des vorgeschlagenen Ortes. Gefüllt für |
| type |
Die spezifische Entitätsart, auf die sich das Ergebnis auflöst. Zum Beispiel eine Adresse, ein besiedelter Ort, ein Park oder ein Wahrzeichen. Siehe |
|
| typeGroup |
Die grobe Klassifizierung des Ergebnisses entweder als Adresse oder als benannter Ort. Siehe |
AutocompleteResponse
Der erfolgreiche Antwortkörper wurde durch zurückgegeben Get Autocomplete. Kodiert als ein GeoJSON FeatureCollection , dessen features Array eine Feature pro Autovervollständigungsvorschlag enthält, von am wahrscheinlichsten bis am wenigsten wahrscheinlich.
| Name | Typ | Beschreibung |
|---|---|---|
| features |
Das Array der |
|
| nextLink |
string |
Enthält die URL, um die nächste Ergebnisseite abzurufen, wenn die Antwort paginiert ist. Dies ist nützlich, wenn die Antwort zu groß ist, um in einem einzigen Aufruf zurückgegeben zu werden, sodass Nutzer durch mehrere Seiten mit Ergebnissen navigieren können. |
| type |
Der |
AutocompleteResultTypeEnum
Eine Klassifikation von Autovervollständigungsvorschlägen, die sowohl als Get Autocomplete Eingabefilter (über den resultTypes Abfrageparameter) als auch als Ausgabeetikett (über das type Feld auf jedem AutocompleteProperties) verwendet werden. Die Mitglieder definieren eine Taxonomie im Gazetteer-Stil, die Adressen, Straßenabschnitte, Verwaltungsregionen, besiedelte Orte, natürliche Merkmale und Sehenswürdigkeiten umfasst. Diese Taxonomie wird in zwei größere Gruppen unterteilt durch AutocompleteResultTypeGroupsEnum: Address, die Adressen und Straßenabschnitte abdecken; und Place, die alle anderen Ergebnistypen abdeckt.
| Wert | Beschreibung |
|---|---|
| Address |
Eine bestimmte Straßenadresse. |
| AdminDivision1 |
Erste Verwaltungsebene innerhalb des Landes/der Region, wie ein Bundesstaat oder eine Provinz. |
| AdminDivision2 |
Zweite Verwaltungsebene innerhalb des Landes/der Region, wie zum Beispiel ein Landkreis. |
| AdminDivision3 |
Dritte Verwaltungsebene innerhalb des Landes/der Region, wie etwa ein Bezirk, eine Pfarrei oder eine Gemeinde. |
| AdministrativeBuilding |
Ein Gebäude, das Regierungsbüros oder öffentliche Verwaltungsfunktionen beherbergt. |
| Airport |
Eine Einrichtung, in der regelmäßig Flugzeuge starten und landen, mit Einrichtungen für Passagiere und Fracht. |
| AirportTerminal |
Ein Passagierterminalgebäude innerhalb eines Flughafens. |
| AmusementPark |
Eine Unterhaltungsanlage mit Fahrgeschäften, Spielen und thematischen Attraktionen. |
| AncientSite |
Ein Ort, an dem archäologische Überreste oder kulturelle Artefakte einer alten Zivilisation aufbewahrt werden. |
| Aquarium |
Eine öffentliche Einrichtung, in der Wasserpflanzen und -tiere ausgestellt und untersucht werden. |
| Archipelago |
Eine Gruppe oder Inselkette. |
| Basin |
Eine natürliche Senke in der Landoberfläche, oft von höherem Gelände umgeben. |
| Battlefield |
Ein Ort einer historisch bedeutenden Landschlacht. |
| Bay |
Ein Gewässer, das teilweise von Land umschlossen ist, kleiner als eine Bucht und größer als eine Bucht. |
| Beach |
Ein Ufer aus Sand, Kieselstein oder anderem unfesten Sediment entlang eines Gewässers. |
| Bridge |
Eine Struktur, die eine Straße, eine Eisenbahn oder einen Weg über ein Hindernis wie einen Fluss, ein Tal oder eine andere Straße trägt. |
| BusinessStructure |
Ein Gebäude, das für allgemeine geschäftliche oder gewerbliche Aktivitäten genutzt wird und nicht in eine spezifischere Kategorie passt. |
| Camp |
Ein Standort mit Unterkünften oder Einrichtungen für vorübergehende Benutzung, wie ein Campingplatz oder eine saisonale Siedlung. |
| Canal |
Ein künstlicher Wasserlauf, der für Transport, Bewässerung oder Entwässerung genutzt wird. |
| Casino |
Eine Einrichtung, die für Glücksspiel und Glücksspiele genutzt wird. |
| Castle |
Ein historisch befestigtes Gebäude oder Gebäudekomplex, typischerweise mit einer adligen oder königlichen Residenz verbunden. |
| Cave |
Eine natürliche unterirdische Kammer oder ein Gang bildete sich im Gestein. |
| Cemetery |
Eine Begräbnisstätte oder ein Friedhof. |
| Channel |
Ein schiffbarer Wasserweg zwischen zwei Landgebieten oder der Hauptstromweg eines größeren Gewässers. |
| Church |
Ein Gebäude, das für den öffentlichen christlichen Gottesdienst genutzt wird. |
| Cliff |
Eine hohe, steile Fels- oder Erdwand, oft mit Blick auf eine Küste oder ein Tal. |
| Coast |
Ein benannter Landstreifen am Meer. |
| CommunityCenter |
Eine Einrichtung, die Gemeinschaftsaktivitäten, Treffen und soziale Dienste ausrichtet. |
| Continent |
Eine der größten Landmassen der Erde. |
| CountryRegion |
Ein Land oder eine Region. |
| Crater |
Eine kreisförmige Senke, die durch vulkanische Aktivität oder Meteoriteneinschlag gebildet wurde. |
| CulturalRegion |
Ein Gebiet, das sich durch gemeinsame kulturelle Merkmale wie Sprache, Ethnie oder Herkunft auszeichnet. |
| Dam |
Eine Barriere, die über einen Bach oder Fluss errichtet wurde, um Wasser aufzufangen. |
| Delta |
Eine Landform aus alluvialen Ablagerungen entstand dort, wo ein Fluss auf ein größeres Gewässer trifft. |
| Desert |
Eine große, trockene Region mit spärlicher Vegetation aufgrund begrenzter Niederschläge. |
| DrainageBasin |
Ein Landgebiet, das von einem Flusssystem und seinen Nebenflüssen entwässert wird. |
| Dune |
Ein Hügel oder Grat aus vom Wind verwehtem Sand. |
| FacilityStructure |
Ein Gebäude, das eine spezialisierte Einrichtung beherbergt, wie zum Beispiel ein Versorgungswerk oder eine Dienstleistungsanlage. |
| FerryTerminal |
Eine Einrichtung, in der Passagiere und Fahrzeuge Fähren ein- und aussteigen. |
| FinancialStructure |
Ein Gebäude, in dem eine Bank, eine Kreditgenossenschaft oder eine andere Finanzdienstleistungsinstitution untergebracht ist. |
| FireStation |
Ein Gebäude, in dem Feuerwehrleute, Ausrüstung und Einsatzfahrzeuge untergebracht sind. |
| Forest |
Ein großes Landgebiet, das von Bäumen dominiert wird. |
| Fort |
Eine militärische Verteidigungsstruktur oder Erdwerke. |
| Garden |
Ein kultivierter Bereich zur Ausstellung von Zierpflanzen oder wissenschaftlich kuratierten Pflanzen. |
| Geyser |
Eine heiße Quelle, die regelmäßig Wasser- und Dampfstrahlen ausstößt. |
| Glacier |
Eine beständige Eismasse, die sich langsam unter ihrem eigenen Gewicht bewegt. |
| GolfCourse |
Ein Feld, das zum Golfspielen angelegt wurde. |
| GreaterPopulatedPlace |
Eine Metropolregion oder Ballungsraum, die einen bewohnten Ort enthält und darüber hinaus reicht. |
| HigherEducationFacility |
Ein College, eine Universität oder eine ähnliche Einrichtung für postsekundäre Bildung. |
| HistoricalSite |
Ein Ort von historischer Bedeutung, oft als Kulturerbestätte erhalten. |
| Hospital |
Eine medizinische Einrichtung, die stationäre und ambulante Versorgung anbietet. |
| HotSpring |
Eine natürliche Quelle, in der geothermisch erhitztes Grundwasser an der Oberfläche entspringt. |
| Ice |
Eine natürliche Masse oder Oberflächenschicht aus gefrorenem Wasser, die Land oder Wasser bedeckt. |
| IndigenousPeoplesReserve |
Ein Gebiet, das als Heimat eines indigenen Volkes oder einer Gemeinschaft anerkannt wird. |
| IndustrialStructure |
Ein Gebäude oder eine Anlage, die für Fertigung, Produktion oder andere industrielle Betriebe genutzt wird. |
| Island |
Eine Landmasse, umgeben von Wasser, kleiner als ein Kontinent. |
| Isthmus |
Ein schmaler Landstreifen, der zwei größere Landmassen verbindet und zwei Gewässer trennt. |
| Lake |
Ein im Landesinneren stehendes Gewässer, umgeben von Land. |
| LandArea |
Eine benannte Landregion, die nicht in eine spezifischere geografische Kategorie passt. |
| Landform |
Ein natürliches Landmerkmal, das nicht in eine spezifischere Kategorie passt, wie z. B. , |
| LandmarkBuilding |
Ein bemerkenswertes Gebäude von architektonischer, kultureller oder historischer Bedeutung, das als erkennbares Wahrzeichen dient. |
| Library |
Ein Gebäude, das eine Sammlung von Büchern und anderen Medien beherbergt, die der Öffentlichkeit zur Verfügung stehen. |
| Lighthouse |
Eine Küsten- oder Hafenstruktur mit einem Navigationslicht zur Navigation von Schiffen. |
| Marina |
Eine Hafenanlage, die Liegeplätze und Dienstleistungen für kleine Boote und Yachten bereitstellt. |
| Market |
Ein Ort, an dem Waren gekauft und verkauft werden, typischerweise im Einzelhandel. |
| MedicalStructure |
Ein Gebäude, das für medizinische oder gesundheitsbezogene Dienste genutzt wird, die nicht ein |
| MetroStation |
Eine Station an einer U-Bahn-, Untergrundbahn- oder einem anderen städtischen Schnellbahnsystem. |
| MilitaryBase |
Eine Einrichtung, die von den Streitkräften für Ausbildung, Versorgung oder Operationen betrieben wird. |
| Mission |
Ein Komplex, der von einer religiösen Gruppe betrieben wird, um Gemeindedienste anzubieten und den Glauben zu verbreiten. |
| Monument |
Eine Gedenkstruktur oder Statue, die zu Ehren einer Person, einem Ereignis oder einer Idee errichtet wurde. |
| Mosque |
Ein Gebäude, das für den öffentlichen islamischen Gottesdienst genutzt wird. |
| Mountain |
Eine Landschaftsform, die deutlich über ihre Umgebung hinausragt, typischerweise mit steilen Hängen und einem markanten Gipfel. |
| MountainRange |
Eine verbundene Bergkette, die eine durchgehende Gebirgskette bildet. |
| MultiModalStation |
Ein Bahnhof, der mehrere Verkehrsmittel bedient, wie zum Beispiel kombinierte Bahn-, Bus- oder Metroverbindungen. |
| Museum |
Eine Einrichtung, in der Objekte von künstlerischem, wissenschaftlichem oder historischem Interesse aufbewahrt und ausgestellt werden. |
| NauticalStructure |
Eine Struktur, die mit maritimer oder nautischer Aktivität zusammenhängt, wie zum Beispiel ein Pier, Steg oder eine Boje. |
| Neighborhood |
Ein lokal anerkanntes Gebiet innerhalb eines bewohnten Ortes, oft mit informellen oder kulturell definierten Grenzen. |
| Oasis |
Ein fruchtbares Gebiet in einer Wüste, die von einer natürlichen Wasserquelle erhalten wird. |
| ObservationPoint |
Ein Aussichtspunkt oder Aussichtspunkt mit malerischen Ausblicken auf die Umgebung. |
| Ocean |
Eine der wichtigsten Bereiche des globalen Ozeans der Erde. |
| OfficeBuilding |
Ein Gebäude, das hauptsächlich für professionelle oder administrative Büroräume genutzt wird. |
| Other |
Ein Vorschlag, der zu keinem anderen definierten Typ passt. |
| Park |
Ein Bereich, der für öffentliche Erholung oder landschaftliches Vergnügen gepflegt wird. |
| ParkingStructure |
Ein mehrstöckiges Gebäude, das dem Parken von Fahrzeugen gewidmet ist. |
| Pass |
Eine schiffbare Route durch oder über ein Gebirge oder ein ähnliches Hindernis. |
| Peninsula |
Eine Landmasse, die in ein Gewässer ragt und fast von diesem umgeben ist. |
| Plain |
Ein ausgedehntes Gebiet mit relativ flachem oder sanft welligem Land. |
| Planet |
Ein Himmelskörper, der einen Stern umkreist, wird typischerweise verwendet, um die Erde als Wurzel der geografischen Hierarchie darzustellen. |
| Plateau |
Ein erhöhtes Gebiet mit relativ ebenem Gelände und steilen Hängen an einer oder mehreren Seiten. |
| Playground |
Ein Erholungsbereich, der für Kinderspiel ausgestattet ist. |
| PlayingField |
Ein offener Bereich, der für organisierte Sportarten genutzt wird. |
| Pole |
Ein geografischer Pol, wie der Nord- oder Südpol. |
| PoliticalUnit |
Eine selbstverwaltete politische Einheit, wie ein unabhängiger oder abhängiger Staat oder ein Territorium. |
| PopulatedPlace |
Ein konzentriertes Gebiet menschlicher Siedlung, wie z. B. eine Stadt, ein Dorf oder ein Dorf. |
| Port |
Eine maritime Einrichtung mit Terminals zum Be- und Entladen von Wasserladung oder Passagieren. |
| Postcode1 |
Die kleinste Postleitzahlenkategorie, wie zum Beispiel eine Postleitzahl. |
| Promontory |
Eine markante erhöhte Landform, die in ein Tiefland oder Gewässer hineinragt. |
| RaceTrack |
Eine Strecke oder ein Parcours, der für Rennfahrzeuge, Tiere oder Athleten angelegt ist. |
| RailwayStation |
Eine Einrichtung, in der Fahrgäste Züge ein- und aussteigen können. |
| Reef |
Ein untergetauchter oder teilweise untergetauchter Grat aus Fels, Sand oder Korallen nahe der Wasseroberfläche. |
| ReligiousStructure |
Ein Gebäude, das für religiöse Gottesdienste oder Praxis genutzt wird und nicht in eine spezifischere Kategorie fällt, wie |
| Reserve |
Ein geschütztes Landstück, das für Naturschutz, Wildtiere oder andere eingeschränkte Nutzung reserviert ist. |
| ResidentialStructure |
Ein Gebäude, das hauptsächlich für menschliche Wohnzwecke genutzt wird, wie zum Beispiel ein Wohnhaus oder Wohnkomplex. |
| River |
Ein natürlicher Wasserlauf, der zu einer niedrigeren Erhebung fließt, typischerweise in Richtung Meer, See oder eines anderen Flusses. |
| RoadBlock |
Ein Straßenabschnitt ohne spezifische Hausnummer, der zurückgegeben wird, wenn der Geocodierungsdienst keine genaue Hausnummer für die Abfrage finden kann. Trotz des Namens deutet dieser Wert nicht auf eine physische Straßensperrung hin. |
| Ruin |
Eine zerstörte oder verfallene Struktur, die ihre ursprüngliche Funktion nicht mehr erfüllt. |
| ScientificResearchBase |
Eine Einrichtung, die als Basis für wissenschaftliche Forschung genutzt wird, oft in abgelegenen oder extremen Umgebungen. |
| Sea |
Ein großes Salzwassergewässer, das teilweise von Land umschlossen ist, kleiner als ein Ozean. |
| SeaplaneLandingArea |
Ein Wasserbereich, der für Wasserflugzeuge zum Start und Landen bestimmt ist. |
| Shrine |
Eine Struktur oder ein Ort, der einer Person gedenkt oder ein heiliges Ereignis oder Konzept würdigt. |
| SkiArea |
Ein Erholungsgebiet wurde für Skifahren und andere Wintersportarten entwickelt. |
| Spring |
Eine natürliche Quelle, in der Grundwasser von der Erdoberfläche fließt. |
| Stadium |
Ein großer Veranstaltungsort mit gestuften Sitzplätzen für Zuschauersportarten oder -veranstaltungen. |
| StatisticalDistrict |
Eine Region, die für statistische oder Volkszählungszwecke definiert ist, wie zum Beispiel ein Metropolitan Statistical Area oder Census Tract. |
| Temple |
Ein Gebäude, das dem religiösen Gottesdienst gewidmet ist. |
| Theater |
Ein Ort zur Aufführung von Theaterstücken, Filmen oder anderen Live- oder Aufnahmeaufführungen. |
| TouristRailway |
Eine Landschafts- oder Museumsbahn wurde hauptsächlich für den Tourismus und nicht für den regulären Nahverkehr betrieben. |
| TouristStructure |
Ein Gebäude, das Touristen bedient, wie ein Besucherzentrum oder ein Touristeninformationsbüro. |
| Trailhead |
Der Ausgangspunkt eines Wander-, Rad- oder Erholungswegs. |
| TransportationStructure |
Eine Struktur, die die Verkehrsinfrastruktur unterstützt, wie z. B. eine Mautstelle, eine Waage oder einen Schutzunterstand. |
| Tunnel |
Ein unterirdischer oder unterirdischer Durchgang für Straßen-, Schienen- oder Fußgängerverkehr. |
| Valley |
Ein langgestrecktes, niedrig gelegenes Gebiet zwischen Hügeln oder Bergen, das oft einen Wasserlauf enthält. |
| Volcano |
Ein Berg oder Hügel, der durch vulkanische Aktivität gebildet wurde, typischerweise mit einem Krater am Gipfel. |
| Walkway |
Ein Weg oder eine asphaltierte Oberfläche, die für Fußgänger vorgesehen ist. |
| Wall |
Eine errichtete Barriere, die eine durchgehende vertikale Grenze bildet und oft zur Verteidigung, Trennung oder Gedenkfeier dient. |
| Waterfall |
Ein Punkt, an dem ein Bach oder Fluss senkrecht oder steil abfällt. |
| WaterFeature |
Ein Gewässer, das nicht in eine spezifischere Kategorie passt, wie zum Beispiel , |
| Wetland |
Ein mit Wasser gesättigtes Landgebiet, das aquatische Vegetation wie ein Sumpf oder Sumpf beherbergt. |
| Winery |
Eine Einrichtung, in der Wein produziert und oft zum Verkosten oder Verkauf angeboten wird. |
| Zoo |
Eine Einrichtung, in der Wildtiere für öffentliche Ausstellungen und Studien gehalten werden. |
AutocompleteResultTypeGroupsEnum
Eine grobe Klassifikation eines autokompletten Vorschlags in eine von zwei Gruppen. Wird sowohl als Get Autocomplete Eingabefilter über den resultTypeGroups Abfrageparameter verwendet (der einschränkt, welche Arten von Vorschlägen zurückgegeben werden) als auch als Ausgabeklassifikator über das typeGroup Feld jeder AutocompleteProperties (um zu identifizieren, zu welcher Gruppe ein zurückgegebener Vorschlag gehört). Die Gruppe Address umfasst einzelne Adressen und Straßenabschnitte; die Place Gruppe umfasst alle anderen Entitätstypen (Verwaltungsregionen, besiedelte Orte, natürliche Merkmale und Sehenswürdigkeiten).
| Wert | Beschreibung |
|---|---|
| Address |
Vorschläge, die sich auf eine bestimmte Adresse oder einen Straßenabschnitt beziehen. |
| Place |
Vorschläge, die sich auf benannte Orte beziehen, einschließlich Verwaltungsregionen, bewohnte Orte, Stadtviertel, natürliche Merkmale und Sehenswürdigkeiten. Beispiele sind : |
Azure.Core.Foundations.Error
Das Fehlerobjekt.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
string |
Eine serverdefinierte Gruppe von Fehlercodes. |
| details |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
|
| innererror |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
| message |
string |
Eine lesbare Darstellung des Fehlers. |
| target |
string |
Das Ziel des Fehlers. |
Azure.Core.Foundations.ErrorResponse
Eine Antwort, die Fehlerdetails enthält.
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
Azure.Core.Foundations.InnerError
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Laut Azure REST API-Richtlinien – https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
string |
Eine serverdefinierte Gruppe von Fehlercodes. |
| innererror |
Innerer Fehler. |
FeatureCollectionEnum
Der GeoJSON Objekttyp, der als Wurzel erfolgreicher Antworten aus den Vorwärts-Geocoding-, Reverse-Geocoding- und Autocomplete-Operationen (einschließlich ihrer Batch-Varianten) verwendet wird. Der einzige Wert ist FeatureCollection, wie in RFC 7946 definiert.
Get Polygon ist die eine Ausnahme: Seine Antwortwurzel ist eine GeoJSON Feature, siehe FeatureTypeEnum.
| Wert | Beschreibung |
|---|---|
| FeatureCollection |
Der Objekttyp |
FeatureTypeEnum
Der GeoJSON Objekttyp für Feature Objekte. Markiert jeden Eintrag innerhalb des features Arrays einer Antwort FeatureCollection (Geocoding, Reverse Geocoding, Autocomplete) und erscheint an der Wurzel der Antwort Get Polygon . Der einzige Wert ist Feature, wie in RFC 7946 definiert.
| Wert | Beschreibung |
|---|---|
| Feature |
Der Objekttyp |
GeoJsonObjectType
Gibt den GeoJSON Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.
| Wert | Beschreibung |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
|
| FeatureCollection |
|
GeoJsonPoint
Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| bbox |
number[] (double) |
Begrenzungsrahmen. Projektion verwendet - EPSG:3857. Weitere Informationen finden Sie unter RFC 7946-. |
| coordinates |
number[] (double) |
Ein |
| type |
string:
Point |
Gibt den |
Intersection
Kreuzungsdetails für eine Adresse, die als Straßenkreuzung definiert ist – die Ecke, an der sich zwei oder mehr benannte Straßen treffen. Nur dann gefüllt, wenn die aufgelöste Entität ein RoadIntersectionist; der Elternteil Address.intersection wird ansonsten weggelassen.
| Name | Typ | Beschreibung |
|---|---|---|
| baseStreet |
string |
Die Hauptstraße der Kreuzung – typischerweise die Straße, auf die sich die Adressnummer bezieht. |
| displayName |
string |
Ein menschenlesbarer Name für die Kreuzung, die die Querstraßen kombiniert, wie |
| intersectionType |
string |
Ein kurzes Etikett, das die Form der Schnittmenge beschreibt. Zum Beispiel die Unterscheidung einer ebenerdigen Kreuzung von einem höhenfreien Übergang wie einer Brücke oder Überführung. |
| secondaryStreet1 |
string |
Die erste Querstraße trifft |
| secondaryStreet2 |
string |
Die zweite Querstraße an der Kreuzung, wenn eine vorhanden ist. Bewohnt nur an Kreuzungen von drei oder mehr Straßen. |