Dataset - Get

Utilisez pour obtenir les détails d’un jeu de données.

Envoyer une demande d’obtention de détails

Pour obtenir les détails d’un jeu de données créé précédemment, vous allez émettre une GET requête avec dans datasetId le chemin d’accès.

Obtenir la réponse détaillée

L’API Obtenir les détails retourne les détails d’un jeu de données au json format. La réponse contient les champs suivants (s’ils ne sont pas null ou vides) :

created : horodatage de la création du jeu de données. datasetId : ID du jeu de données. description : description du jeu de données. datasetSources : données sources utilisées lors de l’émission de la demande de création. ontologie : ontologie source utilisée dans le service de conversion pour les données d’entrée.

Décrit datasetSources les données sources utilisées lors de l’émission de la demande de création et contient les éléments suivants (s’ils ne sont pas null ou vides) :

conversionIds : liste de conversionId (null si aucun n’a été fourni). appendDatasetId : datasetId qui a été utilisé pour une opération d’ajout (null si aucun n’a été utilisé). featureCounts : comptage de chaque type de fonctionnalité dans le jeu de données.

Voici un exemple de réponse qui retourne , timestamp, datasetIddescriptiondatasetSources, et ontology d’une ressource de jeu de données :

{
   "timestamp": "2020-01-01T22:50:48.123Z",
   "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
   "description": "Some description or comment for the dataset.",
   "datasetSources": {
     "conversionIds": [
       "15d21452-c9bb-27b6-5e79-743ca5c3205d"
     ],
   },
   "ontology": "facility-2.0",
   "featureCounts": {
     "directoryInfo": 2,
     "category": 10,
     "facility": 1,
     "level": 3,
     "unit": 183,
     "zone": 3,
     "verticalPenetration": 6,
     "opening": 48,
     "areaElement": 108
   }
 }

GET https://{geography}.atlas.microsoft.com/datasets/{datasetId}?api-version=2.0

Paramètres URI

En-tête de la demande

Réponses

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 ressources 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.

Authorization URL est 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, 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

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, de l’interface CLI, des SDK Azure ou de l’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, notre recommandation est 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 List SAS 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 de grain précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, notre recommandation est 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 SAP.

Type: apiKey
Dans: header

Exemples

Get details for a previously created dataset

GET https://us.atlas.microsoft.com/datasets/[datasetId]?api-version=2.0

Location: https://us.atlas.microsoft.com/dataset/{datasetId}?api-version=1.0
Access-Control-Expose-Headers: Resource-Location

{
  "created": "2021-05-21T01:02:03.456Z",
  "datasetId": "[datasetId]",
  "description": "Some description or comment about the dataset",
  "datasetSources": {
    "conversionIds": [
      "15d21452-c9bb-27b6-5e79-743ca5c3205d",
      "c39de51c-b4f5-4733-aeeb-d8cb6f8b2f1d"
    ],
    "appendDatasetId": "6a49a490-1d9c-4f05-bf1e-51998fbc4733"
  },
  "featureCounts": {
    "directoryInfo": 2,
    "category": 10,
    "facility": 1,
    "level": 3,
    "unit": 183,
    "zone": 3,
    "verticalPenetration": 6,
    "opening": 48,
    "areaElement": 108
  },
  "ontology": "facility-2.0"
}

Définitions

Dataset

Informations détaillées pour le jeu de données.

DatasetSources

Informations sur les détails de la demande de création du jeu de données.

ErrorAdditionalInfo

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

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur