Search - Get Geocode Autocomplete

Tjänst:
Maps
API-version:
2026-01-01

Används för att hämta en rankad lista över föreslagna entiteter baserat på en användares plats och en partiell fråga.
Givet en förfrågan med användarens plats och en partiell fråga som fungerar som prefix till en fullständig frågesträng (kallad frågeprefix), returnerar Azure Maps Autocomplete API en lista över föreslagna enheter som användaren troligen söker efter. Dessa enheter rangordnas från mest till minst sannolika.

GET {endpoint}/geocode:autocomplete?api-version=2026-01-01&query={query}
Med valfria parametrar: 
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-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string (uri)

Azure Maps-tjänstens värdnamn. Använd https://atlas.microsoft.com för Azure publika molnet. För att rikta in dig på en specifik Azure Maps geografi eller ett suveränt moln, se Azure Maps geografisk omfattning.
api-version
 query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.
query
 query True

string

Obligatoriskt. Användarens frågeprefix.

Exempel: "1 Micro" eller "Muir Woods".
bbox
 query

number[]

Obligatoriskt när coordinates det inte har angetts. Ett rektangulärt område på jorden som definieras som ett avgränsningsramobjekt. Rektangelns sidor definieras av longitud- och latitudvärden. När du anger den här parametern tas hänsyn till det geografiska området när resultatet av en platsfråga beräknas.

Exempel: lon1,lat1,lon2,lat2.

Minsta storlek: ungefär 0,00001 grader (~0,01 meter).

Maximal storlek: upp till hela den globala omfattningen (-180,-90 till 180,90)
coordinates
 query

number[]

Obligatoriskt när bbox det inte har angetts. En punkt på jorden som anges som longitud och latitud. När du anger denna parameter tas användarens plats i beaktande och resultaten som returneras kan vara mer relevanta för användaren. Exempel: &koordinater=lon,lat

Not:coordinates blir en sekundär signal om bbox den tillhandahålls.
countryRegion
 query

string

Signal för autokompletteringsresultat till en ISO 3166-1 Alpha-2 region-/landskod som är angiven, t.ex. FR. Endast resultat i det angivna landet/regionen returneras.
resultTypeGroups
 query

AutocompleteResultTypeGroupsEnum[]

En kommaavgränsad lista över returnerade entitetstypgrupper. Möjliga värden är

  • Adress
  • Plats
resultTypes
 query

AutocompleteResultTypeEnum[]

En kommaavgränsad lista över returnerade entitetstyper. När typgruppen är inställd på Adress är de typer som stöds:

  • Adress
  • Vägspärr

Alla andra typer tillhör gruppen Platstyp. Dessa kan omfatta enheter som AdminDivision1, Neighborhood, PopulatedPlace med mera. Standardvärdet är alla möjliga entitetstyper.
top
 query

integer (int32)

minimum: 1
maximum: 20

Maximalt antal svar som ska returneras. Standard: 5, minimum: 1 och maximum: 20.
view
 query

string

En sträng som representerar en ISO 3166-1 Alpha-2-region/landskod. Detta ändrar geopolitiska omtvistade kantlinjer och etiketter så att de överensstämmer med den angivna användarregionen. Som standard är view-parametern inställd på "Auto" även om du inte har definierat den i begäran.

Mer information finns i vyer som stöds och för att se tillgängliga vyer.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-id

string

Specificerar vilket konto som är avsett för användning i kombination med Azure AD:s säkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps management plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps.
Accept-Language

string

Språk där sökresultat ska returneras.

Mer information finns i språk som stöds.

Svar

Name Typ Description
200 OK

AutocompleteResponse

Begäran har slutförts.

Media Types: "application/geo+json", "application/json"
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Ett oväntat felsvar.

Media Types: "application/geo+json", "application/json"

Sidhuvuden

x-ms-error-code: string

Säkerhet

AadToken

Dessa är Microsoft Entra OAuth 2.0 flöden. När den kombineras med Azure rollbaserad åtkomst kontroll kan den användas för att kontrollera åtkomst till Azure Maps REST-API:er. Azure:s rollbaserade åtkomstkontroller används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller delresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Note

  • Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et.
  • Authorization URL är specifik för den offentliga Azure-molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer.
  • Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
  • Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
  • Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
https://atlas.microsoft.com/.default

subscription-key

Det här är en delad nyckel som etableras när du Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Typ: apiKey
I: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll till förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på Map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Autocomplete API call to search for '1 Microsoft'
Autocomplete API call to search for '1 Microsoft Way, Redmond', filtered by roadblock resultTypes, place resultTypeGroups, and return empty result
Autocomplete API call to search for 'Muir Woods', filtered by address resultTypeGroups
Autocomplete API call to search for 'Muir Woods', filtered by park and populated place resultTypes, place resultTypeGroups
Autocomplete API call to search for 'Muir Woods', filtered by park resultTypes
Autocomplete API call to search for 'Muir Woods', filtered by place resultTypeGroups
Autocomplete API call to search for 'Muir Woods', filtered by roadblock resultTypes, address resultTypeGroups

Autocomplete API call to search for '1 Microsoft'

Exempelbegäran

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=1 Microsoft&coordinates=-113.301894,49.201888

Exempelsvar

Statuskod:
200 
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

Exempelbegäran

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

Exempelsvar

Statuskod:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": []
}

Autocomplete API call to search for 'Muir Woods', filtered by address resultTypeGroups

Exempelbegäran

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address

Exempelsvar

Statuskod:
200 
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

Exempelbegäran

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

Exempelsvar

Statuskod:
200 
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

Exempelbegäran

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypes=Park

Exempelsvar

Statuskod:
200 
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

Exempelbegäran

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place

Exempelsvar

Statuskod:
200 
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

Exempelbegäran

GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2026-01-01&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address&resultTypes=RoadBlock

Exempelsvar

Statuskod:
200 
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"
        }
      }
    }
  ]
}

Definitioner

Name Description
Address

Adressen till en geokodad eller autokompletterad föreslagen plats, omfördelad till strukturerade fält. Glesa är normalt: endast de fält som den upplösta enheten tillhandahåller fylls i. Till exempel förekommer streetName och streetNumber endast för gatunivåadresser, och intersection endast för vägkorsningsresultat.
AddressAdminDistrictsItem

En administrativ underavdelning som innehåller en adress. Till exempel en delstat, provins eller län. Returneras som en post i moderarrayen Address.adminDistricts , där poster är ordnade från grovast till finast.
AddressCountryRegion

Det land eller den region som innehåller adressen, identifierad med dess visningsnamn och ISO 3166-1 Alpha-2 landskod. Båda fälten kan utelämnas i ett givet svar.
AutocompleteFeature

En enda post i matrisen features av en AutocompleteResponse, som överensstämmer med GeoJSON Feature objektets form. Representerar ett autokompletteringsförslag: klassificering (type, ), typeGrouptolkad adress och valfritt ortnamn exponeras via properties, med en representativ koordinat för geometry när ett sådant är tillgängligt.
AutocompleteProperties

Nyttolasten properties från en AutocompleteFeature. Bär resultatets klassificering (typeGroup, ), typedess tolkade adress och (för många Place-typade resultat) ett separat visningsnamn.
AutocompleteResponse

Den lyckade responskroppen returnerades med Get Autocomplete. Kodad som en GeoJSON FeatureCollection vars features array innehåller en Feature per autokompletteringsförslag, rangordnad från mest till minst sannolik.
AutocompleteResultTypeEnum

En klassificering av autokompletteringsförslag som används både som Get Autocomplete ett inmatningsfilter (via frågeparametern resultTypes ) och som en utdataetikett (via type fältet på varje AutocompleteProperties). Medlemmarna definierar en taxonomi i gazetteer-stil som omfattar adresser, vägsegment, administrativa regioner, befolkade platser, naturfenomen och intressanta platser. Denna taxonomi delas in i två bredare grupper av: AutocompleteResultTypeGroupsEnumAddress, som täcker adresser och vägsegment; och Place, som täcker alla andra resultattyper.
AutocompleteResultTypeGroupsEnum

En grov klassificering av ett autokompletterande förslag i en av två grupper. Används både som Get Autocomplete ett indatafilter via frågeparametern resultTypeGroups (vilket begränsar vilka typer av förslag som returneras) och som en utdataklassificerare via typeGroup fältet på varje AutocompleteProperties (som identifierar vilken grupp ett returnerat förslag tillhör). Gruppen Address täcker enskilda adresser och gatusegment; gruppen Place omfattar alla andra entitetstyper (administrativa regioner, befolkade platser, natursärdrag och intressanta platser).
Azure.Core.Foundations.Error

Felobjektet.
Azure.Core.Foundations.ErrorResponse

Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError

Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors.
FeatureCollectionEnum

Objekttypen GeoJSON som används vid roten till framgångsrika svar från framåtriktad geokodning, omvänd geokodning och autokomplettering (inklusive deras batchvarianter). Det enda värdet är FeatureCollection, enligt definitionen i RFC 7946. Get Polygon är det enda undantaget: dess svarsrot är en GeoJSON Feature, se FeatureTypeEnum.
FeatureTypeEnum

Objekttypen GeoJSON för Feature objekt. Taggar varje post inom arrayen features av ett FeatureCollection svar (geokodning, omvänd geokodning, autokomplettering) och visas vid roten av svaret Get Polygon . Det enda värdet är Feature, enligt definitionen i RFC 7946.
GeoJsonObjectType

Anger GeoJSON typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.
GeoJsonPoint

En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946.
Intersection

Korsningsdetaljer för en adress är avslutade som en vägkorsning — hörnet där två eller flera namngivna gator möts. Fylls endast när den lösta enheten är en RoadIntersection; föräldern Address.intersection utelämnas annars.

Address

Objekt

Adressen till en geokodad eller autokompletterad föreslagen plats, omfördelad till strukturerade fält. Glesa är normalt: endast de fält som den upplösta enheten tillhandahåller fylls i. Till exempel förekommer streetName och streetNumber endast för gatunivåadresser, och intersection endast för vägkorsningsresultat.

Name Typ Description
addressLine

string

Den första raden i adressen, vanligtvis gatunamn och nummer. Till exempel "15127 NE 24th St".
adminDistricts

AddressAdminDistrictsItem[]

De administrativa underavdelningarna som innehåller adressen, ordnade från grovast till finast. Den första posten är vanligtvis den första ordningens underindelning (såsom en amerikansk delstat eller en kanadensisk provins); Efterföljande poster täcker finare indelningar där landet, beroendelandet eller regionen definierar dem (såsom ett län på index 1).
countryRegion

AddressCountryRegion

Landet eller regionen som innehåller adressen, med dess visningsnamn och ISO 3166-1 Alpha-2 landskod.
formattedAddress

string

Hela adressen återgavs som en enda mänskligt läsbar sträng, där komponenterna fogades enligt konventionerna i adressens land eller region. Exempel: "15127 NE 24th St, Redmond, WA 98052".
intersection

Intersection

De korsande gatuuppgifterna för adressen, fyllda när den upplösta enheten är en RoadIntersection (såsom hörnet av två namngivet gator).
locality

string

Platsen adressen tillhör: vanligtvis en stad, ort eller by. Till exempel: "Redmond".
neighborhood

string

Det namngivna området inom området, när ett sådant identifieras.
postalCode

string

Postnumret för adressen, när det definieras. Exempel: "98052".
streetName

string

Gatunamnskomponenten i adressen, när den lösta enheten är en gatunivåadress. Exempel: "NE 24th St".
streetNumber

string

Hus- eller byggnadsnumret på gatan, när den lösta enheten är en gatunivåadress. Exempel: "15127".

AddressAdminDistrictsItem

Objekt

En administrativ underavdelning som innehåller en adress. Till exempel en delstat, provins eller län. Returneras som en post i moderarrayen Address.adminDistricts , där poster är ordnade från grovast till finast.

Name Typ Description
name

string

Det fullständiga namnet på bostadsområdet. Till exempel "Washington" för en amerikansk delstat eller "King County" för ett län.
shortName

string

Den korta eller förkortade formen av underavdelningsnamnet, när ett sådant definieras. Till exempel "WA" för en amerikansk delstat. Finare indelningar har ofta ingen distinkt kortform, i vilket fall shortName upprepas name (såsom "King County").

AddressCountryRegion

Objekt

Det land eller den region som innehåller adressen, identifierad med dess visningsnamn och ISO 3166-1 Alpha-2 landskod. Båda fälten kan utelämnas i ett givet svar.

Name Typ Description
ISO

string

ISO 3166-1 Alpha-2 landskod för landet eller regionen. Till exempel "US" för United States, eller "GB" för Storbritannien.
name

string

Landets eller regionens visningsnamn. Till exempel "United States".

AutocompleteFeature

Objekt

En enda post i matrisen features av en AutocompleteResponse, som överensstämmer med GeoJSON Feature objektets form. Representerar ett autokompletteringsförslag: klassificering (type, ), typeGrouptolkad adress och valfritt ortnamn exponeras via properties, med en representativ koordinat för geometry när ett sådant är tillgängligt.

Name Typ Description
geometry

GeoJsonPoint

Koordinaten för autokompletteringsförslaget som en GeoJSON Point, med värden i WGS 84 longitud/latitud-ordning. Kan utelämnas när förslaget inte löser sig till en enda representativ koordinat, till exempel breda regionala eller ortnamnsförslag.
properties

AutocompleteProperties

Strukturerad data om autofyllningsförslaget, inklusive dess klassificering, tolkad adress och (för Place-typade förslag) platsnamn. Se AutocompleteProperties för per-egenskapsformen.
type

FeatureTypeEnum

Objekttypen GeoJSON . Alltid Feature, som definierat i RFC 7946.

AutocompleteProperties

Objekt

Nyttolasten properties från en AutocompleteFeature. Bär resultatets klassificering (typeGroup, ), typedess tolkade adress och (för många Place-typade resultat) ett separat visningsnamn.

Name Typ Description
address

Address

Adressen till autokompletteringsresultatet, parsat till strukturerade fält. Address-typade resultat inkluderar vanligtvis detaljer på gatunivå; Place-typade resultat innehåller lokalitet, administrativa distrikt och land/region (gatunivåfält utelämnas vanligtvis).
name

string

Visningsnamnet på den föreslagna platsen. Fylls i för Place-typade resultat när namnet inte redan representeras i den strukturerade address (till exempel parker, landmärken eller andra namngivna funktioner). Utelämnad för Address-typade resultat och för Place-typade resultat vars namn redan finns med i address (såsom en befolkad plats vars namn förekommer i address.locality).
type

AutocompleteResultTypeEnum

Den specifika entitetstypen som resultatet resolveras i. Till exempel en adress, en bebodd plats, en park eller ett landmärke. Se AutocompleteResultTypeEnum för hela värdelistan, uppdelad i Address och-grupperna Place med AutocompleteResultTypeGroupsEnum.
typeGroup

AutocompleteResultTypeGroupsEnum

Den breda klassificeringen av resultatet som antingen en adress eller en namngiven plats. Se AutocompleteResultTypeGroupsEnum för värdelistan.

AutocompleteResponse

Objekt

Den lyckade responskroppen returnerades med Get Autocomplete. Kodad som en GeoJSON FeatureCollection vars features array innehåller en Feature per autokompletteringsförslag, rangordnad från mest till minst sannolik.

Name Typ Description
features

AutocompleteFeature[]

Arrayen av GeoJSON Feature objekt som returneras av frågan. Varje Feature representerar ett enda autokompletteringsförslag: dess klassificering (type, typeGroup), tolkade adress och valfritt ortnamn exponeras via properties, och dess primära koordinat via geometry.
nextLink

string

Innehåller URL:en för att hämta nästa resultatsida om svaret är paginerat. Detta är användbart när svaret är för stort för att besvaras i ett enda samtal, vilket gör att användare kan navigera genom flera sidor med resultat.
type

FeatureCollectionEnum

Objekttypen GeoJSON för en lyckad Get Autocomplete responskropp. Alltid FeatureCollection, som definierat i RFC 7946.

AutocompleteResultTypeEnum

Uppräkning

En klassificering av autokompletteringsförslag som används både som Get Autocomplete ett inmatningsfilter (via frågeparametern resultTypes ) och som en utdataetikett (via type fältet på varje AutocompleteProperties). Medlemmarna definierar en taxonomi i gazetteer-stil som omfattar adresser, vägsegment, administrativa regioner, befolkade platser, naturfenomen och intressanta platser. Denna taxonomi delas in i två bredare grupper av: AutocompleteResultTypeGroupsEnumAddress, som täcker adresser och vägsegment; och Place, som täcker alla andra resultattyper.

Värde Description
Address

En specifik gatuadress.
AdminDivision1

Första administrativa nivån inom landet/regionen, såsom en delstat eller en provins.
AdminDivision2

Andra administrativa nivån inom landet/regionen, såsom ett län.
AdminDivision3

Tredje administrativa nivån inom landet/regionen, såsom ett distrikt, en församling eller kommun.
AdministrativeBuilding

En byggnad som rymmer myndighetskontor eller offentliga administrativa funktioner.
Airport

En anläggning där flygplan regelbundet lyfter och landar, med faciliteter för passagerare och last.
AirportTerminal

En passagerarterminalbyggnad inom en flygplats.
AmusementPark

En underhållningsanläggning med åkattraktioner, spel och temaattraktioner.
AncientSite

En plats där arkeologiska lämningar eller kulturella artefakter från en forntida civilisation bevaras.
Aquarium

En offentlig anläggning där vattenväxter och djur visas och studeras.
Archipelago

En grupp eller kedja av öar.
Basin

En naturlig sänka i landytan, ofta omgiven av högre terräng.
Battlefield

En plats för ett historiskt betydelsefullt markslag.
Bay

En vattenmassa delvis innesluten av land, mindre än en vik och större än en vik.
Beach

En strand av sand, småsten eller annat osammanfogat sediment längs en vattenmassa.
Bridge

En struktur som bär en väg, järnväg eller stig över ett hinder som en flod, dal eller annan väg.
BusinessStructure

En byggnad som används för allmän affärsverksamhet eller kommersiella aktiviteter som inte passar in i en mer specifik kategori.
Camp

En plats med skydd eller faciliteter för tillfällig användning, såsom en campingplats eller säsongsbosättning.
Canal

Ett konstgjort vattendrag som används för transport, bevattning eller dränering.
Casino

En anläggning som används för spel och hasardspel.
Castle

En historiskt befäst byggnad eller komplex av byggnader, vanligtvis förknippad med adliga eller kungliga residens.
Cave

En naturlig underjordisk kammare eller passage bildades i berget.
Cemetery

En begravningsplats eller kyrkogård.
Channel

En farbar vattenväg mellan två landområden eller huvudflödesvägen för en större vattenmassa.
Church

En byggnad som används för offentlig kristen gudstjänst.
Cliff

En hög, brant klippvägg eller jord, ofta med utsikt över en kust eller dal.
Coast

Ett namngivet landområde som gränsar till havet.
CommunityCenter

En anläggning som anordnar samhällsaktiviteter, möten och sociala tjänster.
Continent

En av jordens stora landmassor.
CountryRegion

Ett land eller en region.
Crater

En cirkulär sänka bildad av vulkanisk aktivitet eller meteoritnedslag.
CulturalRegion

Ett område som kännetecknas av gemensamma kulturella kännetecken, såsom språk, etnicitet eller arv.
Dam

En barriär byggd över en bäck eller flod för att samla vatten.
Delta

En landform av alluviala avlagringar bildades där en flod möter ett större vattendrag.
Desert

Ett stort torrt område med gles vegetation på grund av begränsad nederbörd.
DrainageBasin

Ett landområde dränerat av ett flodsystem och dess bifloder.
Dune

En hög eller ås av vindpinad sand.
FacilityStructure

En byggnad som rymmer en specialiserad anläggning, såsom ett elverk eller en serviceinstallation.
FerryTerminal

En anläggning där passagerare och fordon går på och av färjor.
FinancialStructure

En byggnad som rymmer en bank, kreditförening eller annan finansiell tjänsteinstitution.
FireStation

En byggnad som rymmer brandmän, utrustning och räddningsfordon.
Forest

Ett stort markområde dominerat av träd.
Fort

En försvarsmilitär struktur eller jordvallar.
Garden

Ett odlat område för att visa prydnads- eller vetenskapligt kurerade växter.
Geyser

En varm källa som periodvis sprutar ut vatten- och ångstrålar.
Glacier

En ihållande ismassa som rör sig långsamt under sin egen vikt.
GolfCourse

En plan anlagd för golfspel.
GreaterPopulatedPlace

Ett storstadsområde eller storstadsområde som innehåller och sträcker sig bortom en befolkad plats.
HigherEducationFacility

Ett college, universitet eller liknande institution för eftergymnasial utbildning.
HistoricalSite

En plats av historisk betydelse, ofta bevarad som ett kulturarv.
Hospital

En medicinsk anläggning som erbjuder slutenvård och öppenvård.
HotSpring

En naturlig källa där geotermiskt uppvärmt grundvatten kommer upp vid ytan.
Ice

En naturlig massa eller yta av fruset vatten som täcker land eller vatten.
IndigenousPeoplesReserve

Ett territorium som erkänns som hemland för ett ursprungsfolk eller samhälle.
IndustrialStructure

En byggnad eller anläggning som används för tillverkning, produktion eller andra industriella verksamheter.
Island

En landmassa omgiven av vatten, mindre än en kontinent.
Isthmus

En smal remsa land som förbinder två större landmassor och skiljer två vattendrag åt.
Lake

Ett inlandsvatten med stillastående vatten omgivet av land.
LandArea

En namngiven landregion som inte passar in i en mer specifik geografisk kategori.
Landform

En naturlig markegenskap som inte passar in i en mer specifik kategori, såsom en Mountain, Valley, eller Plateau.
LandmarkBuilding

En anmärkningsvärd byggnad av arkitektonisk, kulturell eller historisk betydelse som fungerar som ett igenkännbart landmärke.
Library

En byggnad som rymmer en samling böcker och annat media tillgängligt för allmänheten.
Lighthouse

En kust- eller hamnstruktur som visar ett navigationsljus för att vägleda fartyg.
Marina

En hamnanläggning som erbjuder förtöjningar och tjänster för små båtar och yachter.
Market

En plats där varor köps och säljs, vanligtvis i detaljhandel.
MedicalStructure

En byggnad som används för medicinska eller hälsorelaterade tjänster utöver en Hospital, såsom en klinik eller medicinskt kontor.
MetroStation

En station på tunnelbana, underjordisk eller annan urban snabbspårvägssystem.
MilitaryBase

En anläggning som drivs av de väpnade styrkorna för utbildning, försörjning eller operationer.
Mission

Ett komplex som drivs av en religiös grupp för att tillhandahålla samhällstjänster och sprida tron.
Monument

En minnesbyggnad eller staty som rests för att hedra en person, händelse eller idé.
Mosque

En byggnad som används för offentlig islamisk gudstjänst.
Mountain

En landform som reser sig betydligt över omgivningen, vanligtvis med branta sluttningar och en tydlig topp.
MountainRange

En sammanhängande serie av berg som bildar en sammanhängande kedja.
MultiModalStation

En station som betjänar flera transportsätt, såsom kombinerad järnväg, buss eller tunnelbanetrafik.
Museum

En anläggning där föremål av konstnärligt, vetenskapligt eller historiskt intresse bevaras och ställs ut.
NauticalStructure

En struktur relaterad till maritim eller nautisk verksamhet, såsom en brygga, kaj eller boj.
Neighborhood

Ett lokalt erkänt område inom en befolkad plats, ofta med informella eller kulturellt definierade gränser.
Oasis

Ett bördigt område i en öken som upprätthålls av en naturlig vattenkälla.
ObservationPoint

En utsiktspunkt eller utsiktspunkt med natursköna vyer över omgivningen.
Ocean

En av de stora avdelningarna i jordens globala hav.
OfficeBuilding

En byggnad som främst används för professionella eller administrativa kontorslokaler.
Other

Ett förslag som inte passar in i någon annan definierad typ.
Park

Ett område som underhålls för allmän rekreation eller naturskönt nöje.
ParkingStructure

En flervåningsbyggnad dedikerad till bilparkering.
Pass

En navigerbar väg genom eller över en bergskedja eller liknande hinder.
Peninsula

En landmassa som skjuter ut i en vattenmassa och nästan är omgiven av den.
Plain

Ett omfattande område med relativt platt eller lätt kuperad mark.
Planet

En himlakropp som kretsar kring en stjärna, används vanligtvis för att representera jorden som roten till den geografiska hierarkin.
Plateau

Ett upphöjt område med relativt jämnt land och branta sluttningar på en eller flera sidor.
Playground

Ett rekreationsområde utrustat för barnlek.
PlayingField

Ett öppet område som används för organiserad sport.
Pole

En geografisk pol, såsom Nord- eller Sydpolen.
PoliticalUnit

En självstyrande politisk enhet, såsom en självständig eller beroende stat eller territorium.
PopulatedPlace

Ett koncentrerat område av mänsklig bosättning, såsom en stad, stad eller by.
Port

En maritim anläggning med terminaler för lastning och lossning av vattenburna gods eller passagerare.
Postcode1

Den minsta postnummerkategorin, såsom ett postnummer.
Promontory

En framträdande upphöjd landform som skjuter ut i ett lågland eller vattendrag.
RaceTrack

En bana eller bana anlagd för racerfordon, djur eller idrottare.
RailwayStation

En anläggning där passagerare går på och av tåg.
Reef

En nedsänkt eller delvis nedsänkt bergsrygg av sten, sand eller korall nära vattenytan.
ReligiousStructure

En byggnad som används för religiös gudstjänst eller praktik men som inte passar in i en mer specifik kategori, såsom Church, Mosque, eller Temple.
Reserve

Ett skyddat markområde avsatt för bevarande, djurliv eller annan begränsad användning.
ResidentialStructure

En byggnad som främst används för mänskligt boende, såsom en lägenhet eller bostadskomplex.
River

Ett naturligt vattendrag som rinner till en lägre höjd, vanligtvis mot ett hav, en sjö eller en annan flod.
RoadBlock

Ett gatusegment utan ett specifikt husnummer, returnerat när geokodningstjänsten inte kan hitta ett exakt husnummer för sökningen. Trots namnet innebär detta värde inte att det är någon fysisk vägavstängning.
Ruin

En förstörd eller förfallen struktur som inte längre fyller sin ursprungliga funktion.
ScientificResearchBase

En anläggning som används som bas för vetenskaplig forskning, ofta i avlägsna eller extrema miljöer.
Sea

En stor saltvattenmassa delvis innesluten av land, mindre än ett hav.
SeaplaneLandingArea

Ett vattenområde avsett för sjöflygplan att starta och landa.
Shrine

En byggnad eller plats som hedrar en person eller hedrar en helig händelse eller ett begrepp.
SkiArea

Ett rekreationsområde utvecklades för skidåkning och andra vintersporter.
Spring

En naturlig källa där grundvatten rinner från jordytan.
Stadium

En stor arena med trappuppdelade sittplatser för åskådarsporter eller evenemang.
StatisticalDistrict

En region definierad för statistiska eller folkräkningsändamål, såsom ett storstadsområde eller ett folkräkningsområde.
Temple

En byggnad tillägnad religiös gudstjänst.
Theater

En plats för att framföra pjäser, filmer eller andra live- eller inspelade framträdanden.
TouristRailway

En naturskön eller kulturarvsjärnväg drevs främst för turism snarare än reguljär kollektivtrafik.
TouristStructure

En byggnad som betjänar turister, såsom ett besökscenter eller turistinformationskontor.
Trailhead

Startpunkten för en vandrings-, cykel- eller rekreationsled.
TransportationStructure

En struktur som stödjer transportinfrastruktur, såsom en tullstation, vågstation eller kollektivtrafikkur.
Tunnel

En underjordisk eller undervattenspassage för väg-, järnvägs- eller gångtrafik.
Valley

Ett avlångt låglänt område mellan kullar eller berg, ofta med en vattendrag.
Volcano

Ett berg eller en kulle bildad av vulkanisk aktivitet, vanligtvis med en krater på toppen.
Walkway

En stig eller asfalterad yta avsedd för fotgängare.
Wall

En konstruerad barriär som bildar en sammanhängande vertikal gräns, ofta använd för försvar, separation eller minneshögtid.
Waterfall

En punkt där en bäck eller flod faller vertikalt eller brant.
WaterFeature

En vattenmassa som inte passar in i en mer specifik kategori, såsom en Lake, River, eller Sea.
Wetland

Ett område med vatten som är mättat med vatten och stödjer vattenväxter, såsom en våtmark eller sumpmark.
Winery

En anläggning där vin produceras och ofta erbjuds för provsmakning eller försäljning.
Zoo

En anläggning där vilda djur hålls för allmän utställning och studier.

AutocompleteResultTypeGroupsEnum

Uppräkning

En grov klassificering av ett autokompletterande förslag i en av två grupper. Används både som Get Autocomplete ett indatafilter via frågeparametern resultTypeGroups (vilket begränsar vilka typer av förslag som returneras) och som en utdataklassificerare via typeGroup fältet på varje AutocompleteProperties (som identifierar vilken grupp ett returnerat förslag tillhör). Gruppen Address täcker enskilda adresser och gatusegment; gruppen Place omfattar alla andra entitetstyper (administrativa regioner, befolkade platser, natursärdrag och intressanta platser).

Värde Description
Address

Förslag som redovisas för en specifik adress eller ett vägsegment.
Place

Förslag som riktar sig till namngivna platser, inklusive administrativa regioner, bebodda platser, stadsdelar, naturfenomen och intressanta platser. Exempel är AdminDivision1, Neighborhoodoch PopulatedPlace.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.
details

Azure.Core.Foundations.Error[]

En matris med information om specifika fel som ledde till det rapporterade felet.
innererror

Azure.Core.Foundations.InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message

string

En mänsklig läsbar representation av felet.
target

string

Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name Typ Description
error

Azure.Core.Foundations.Error

Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.
innererror

Azure.Core.Foundations.InnerError

Inre fel.

FeatureCollectionEnum

Uppräkning

Objekttypen GeoJSON som används vid roten till framgångsrika svar från framåtriktad geokodning, omvänd geokodning och autokomplettering (inklusive deras batchvarianter). Det enda värdet är FeatureCollection, enligt definitionen i RFC 7946. Get Polygon är det enda undantaget: dess svarsrot är en GeoJSON Feature, se FeatureTypeEnum.

Värde Description
FeatureCollection

Objekttypen GeoJSON FeatureCollection . Förekommer som roten till varje framgångsrik geokodning, omvänd geokodning och autokompletteringsrespons. Get Polygon använder istället en Feature rot.

FeatureTypeEnum

Uppräkning

Objekttypen GeoJSON för Feature objekt. Taggar varje post inom arrayen features av ett FeatureCollection svar (geokodning, omvänd geokodning, autokomplettering) och visas vid roten av svaret Get Polygon . Det enda värdet är Feature, enligt definitionen i RFC 7946.

Värde Description
Feature

Objekttypen GeoJSON Feature . Förekommer på varje funktion inuti ett FeatureCollection svar, och vid roten av svaret Get Polygon .

GeoJsonObjectType

Uppräkning

Anger GeoJSON typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

Värde Description
Point

GeoJSON Point geometri.
MultiPoint

GeoJSON MultiPoint geometri.
LineString

GeoJSON LineString geometri.
MultiLineString

GeoJSON MultiLineString geometri.
Polygon

GeoJSON Polygon geometri.
MultiPolygon

GeoJSON MultiPolygon geometri.
GeometryCollection

GeoJSON GeometryCollection geometri.
Feature

GeoJSON Feature objekt.
FeatureCollection

GeoJSON FeatureCollection objekt.

GeoJsonPoint

Objekt

En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946.

Name Typ Description
bbox

number[] (double)

Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946.
coordinates

number[] (double)

En Position är en matris med tal med två eller flera element. De första två elementen är longitud och latitud, just i den ordningen. Altitude/Elevation är ett valfritt tredje element. Mer information finns i RFC 7946.
type string:

Point

Anger GeoJSON typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.

Intersection

Objekt

Korsningsdetaljer för en adress är avslutade som en vägkorsning — hörnet där två eller flera namngivna gator möts. Fylls endast när den lösta enheten är en RoadIntersection; föräldern Address.intersection utelämnas annars.

Name Typ Description
baseStreet

string

Den primära gatan i korsningen — vanligtvis gatan som adressnumret refererar till.
displayName

string

Ett människoläsbart namn för korsningen som kombinerar korsningsgatorna, såsom "5th Avenue & Main Street".
intersectionType

string

En kort etikett som beskriver formen på skärningen. Till exempel att skilja en plankorsning från en planskild överfart som en bro eller viadukt.
secondaryStreet1

string

Den första korsgatan som möts baseStreet vid korsningen.
secondaryStreet2

string

Den andra korsgatan vid korsningen, när en sådan finns där. Befolkad endast vid korsningar med tre eller fler gator.