Partager via


Search - Get Search Polygon

Utilisez pour obtenir les données polygonales d’une forme de zone géographique, telle qu’une ville ou une région de pays.

L’API Get Polygon est une requête HTTP GET qui retourne des données géométriques telles qu’un plan de ville ou de pays/région pour un ensemble d’entités, précédemment récupérées à partir d’une demande de recherche en ligne au format GeoJSON. L’ID geometry est retourné dans l’objet sourceGeometry sous « geometry » et « id » dans un appel Recherche Address ou Recherche Fuzzy.

Un ID geometry récupéré à partir d’un point de terminaison de recherche en ligne a une durée de vie limitée. Il n’est pas recommandé de stocker les ID géométriques dans un stockage persistant pour une référence ultérieure. Il est attendu qu’une requête à la méthode Polygon soit effectuée dans les quelques minutes suivant la demande à la méthode de recherche en ligne qui a fourni l’ID. Le service autorise les demandes par lots jusqu’à 20 identificateurs.

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}

Paramètres URI

Nom Dans Obligatoire Type Description
format
path True

JsonFormat

Format souhaité de la réponse. Seul le format json est pris en charge.

api-version
query True

string

Numéro de version de l’API Azure Maps.

geometries
query True

string[]

Liste séparée par des virgules des UUID géométriques, précédemment récupérées à partir d’une demande de recherche en ligne.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-id

string

Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Microsoft Entra ID. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser Microsoft Entra ID sécurité dans Azure Maps consultez les articles suivants pour obtenir des conseils.

Réponses

Nom Type Description
200 OK

PolygonResult

Ok

Other Status Codes

ErrorResponse

Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressource ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

  • Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion maps .
  • est Authorization URL spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation et des configurations Microsoft Entra ID uniques.
  • Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.
  • L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
  • Pour plus d’informations sur Plateforme d'identités Microsoft, consultez Plateforme d'identités Microsoft vue d’ensemble.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lorsque vous créez un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, cli, kits SDK Azure ou API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé master dans le compte dans lequel elle est émise.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’approche des applications clientes confidentielles pour accéder Azure Maps API REST afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération Répertorier les SAP sur la ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou 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 à la ou les régions d’utilisation du 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 Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAS.

Type: apiKey
Dans: header

Exemples

Exemple de requête

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca

Exemple de réponse

{
  "additionalData": [
    {
      "providerID": "1111-2222-32-4444444444444",
      "geometryData": {
        "type": "FeatureCollection",
        "features": [
          {
            "type": "Feature",
            "properties": {},
            "geometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    -122.0665062,
                    47.6496252
                  ],
                  [
                    -122.0664863,
                    47.6496113
                  ],
                  [
                    -122.0664843,
                    47.6496014
                  ],
                  [
                    -122.0663693,
                    47.6495247
                  ],
                  [
                    -122.0663017,
                    47.6494664
                  ],
                  [
                    -122.0662679,
                    47.6494247
                  ],
                  [
                    -122.0661647,
                    47.6493314
                  ],
                  [
                    -122.067177,
                    47.649298
                  ],
                  [
                    -122.090715,
                    47.6543598
                  ],
                  [
                    -122.0907846,
                    47.6542921
                  ],
                  [
                    -122.0908284,
                    47.6542603
                  ]
                ]
              ]
            },
            "id": "1111-2222-32-4444444444444"
          }
        ]
      }
    }
  ]
}

Définitions

Nom Description
ErrorAdditionalInfo

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

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

GeoJsonFeature

Type d’objet valide GeoJSON Feature . Pour plus d’informations, consultez RFC 7946 .

GeoJsonFeatureCollection

Type d’objet valide GeoJSON FeatureCollection . Pour plus d’informations, consultez RFC 7946 .

GeoJsonGeometry

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

GeoJsonGeometryCollection

Type d’objet valide GeoJSON GeometryCollection . Pour plus d’informations, consultez RFC 7946 .

GeoJsonLineString

Type geometry valide GeoJSON LineString . Pour plus d’informations, consultez RFC 7946 .

GeoJsonMultiLineString

Type geometry valide GeoJSON MultiLineString . Pour plus d’informations, consultez RFC 7946 .

GeoJsonMultiPoint

Type geometry valide GeoJSON MultiPoint . Pour plus d’informations, consultez RFC 7946 .

GeoJsonMultiPolygon

Type d’objet valide GeoJSON MultiPolygon . Pour plus d’informations, consultez RFC 7946 .

GeoJsonPoint

Type geometry valide GeoJSON Point . Pour plus d’informations, consultez RFC 7946 .

GeoJsonPolygon

Type geometry valide GeoJSON Polygon . Pour plus d’informations, consultez RFC 7946 .

JsonFormat

Format souhaité de la réponse. Seul le format json est pris en charge.

Polygon
PolygonResult

Cet objet est retourné à partir d’un appel polygon Recherche réussi

ErrorAdditionalInfo

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

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet error.

GeoJsonFeature

Type d’objet valide GeoJSON Feature . Pour plus d’informations, consultez RFC 7946 .

Nom Type Description
featureType

string

Type de la fonctionnalité. La valeur dépend du modèle de données dont fait partie la fonctionnalité actuelle. Certains modèles de données peuvent avoir une valeur vide.

geometry GeoJsonGeometry:

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

id

string

Identificateur de la fonctionnalité.

type string:

Feature

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.

GeoJsonFeatureCollection

Type d’objet valide GeoJSON FeatureCollection . Pour plus d’informations, consultez RFC 7946 .

Nom Type Description
features

GeoJsonFeature[]

Contient une liste d’objets valides GeoJSON Feature .

type string:

FeatureCollection

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.

GeoJsonGeometry

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

Nom Type Description
type

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.

GeoJsonGeometryCollection

Type d’objet valide GeoJSON GeometryCollection . Pour plus d’informations, consultez RFC 7946 .

Nom Type Description
geometries GeoJsonGeometry[]:

Contient une liste d’objets géométriques valides GeoJSON . Notez que les coordonnées dans GeoJSON sont dans l’ordre x, y (longitude, latitude).

type string:

GeometryCollection

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.

GeoJsonLineString

Type geometry valide GeoJSON LineString . Pour plus d’informations, consultez RFC 7946 .

Nom Type Description
coordinates

number[]

Coordonnées de la GeoJson LineString géométrie.

type string:

LineString

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.

GeoJsonMultiLineString

Type geometry valide GeoJSON MultiLineString . Pour plus d’informations, consultez RFC 7946 .

Nom Type Description
coordinates

number[]

Coordonnées de la GeoJson MultiLineString géométrie.

type string:

MultiLineString

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.

GeoJsonMultiPoint

Type geometry valide GeoJSON MultiPoint . Pour plus d’informations, consultez RFC 7946 .

Nom Type Description
coordinates

number[]

Coordonnées de la GeoJson MultiPoint géométrie.

type string:

MultiPoint

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.

GeoJsonMultiPolygon

Type d’objet valide GeoJSON MultiPolygon . Pour plus d’informations, consultez RFC 7946 .

Nom Type Description
coordinates

number[]

Contient une liste d’objets valides GeoJSON Polygon . Notez que les coordonnées dans GeoJSON sont dans l’ordre x, y (longitude, latitude).

type string:

MultiPolygon

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.

GeoJsonPoint

Type geometry valide GeoJSON Point . Pour plus d’informations, consultez RFC 7946 .

Nom Type Description
coordinates

number[]

Un Position est un tableau de nombres avec deux éléments ou plus. Les deux premiers éléments sont la longitude et la latitude, précisément dans cet ordre. Altitude/Elevation est un troisième élément facultatif. Pour plus d’informations, consultez RFC 7946 .

type string:

Point

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.

GeoJsonPolygon

Type geometry valide GeoJSON Polygon . Pour plus d’informations, consultez RFC 7946 .

Nom Type Description
coordinates

number[]

Coordonnées du GeoJson Polygon type geometry.

type string:

Polygon

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.

JsonFormat

Format souhaité de la réponse. Seul le format json est pris en charge.

Nom Type Description
json

string

Format d’échange de données de notation d’objet JavaScript

Polygon

Nom Type Description
geometryData GeoJsonObject:

Données geometry au format GeoJSON. Pour plus d’informations, consultez RFC 7946 . Présente uniquement si « error » n’est pas présent.

providerID

string

ID de l’entité retournée

PolygonResult

Cet objet est retourné à partir d’un appel polygon Recherche réussi

Nom Type Description
additionalData

Polygon[]

Tableau de résultats