Dataset - List
Utilisez pour obtenir la liste des jeux de données.
Envoyer une demande de liste
Pour répertorier tous vos jeux de données, émettez une GET
requête sans paramètres supplémentaires.
Lister la réponse des données
Voici un exemple de réponse qui retourne les timestamp
ressources , , datasetId
description
, datasetSources
et ontology
de 2 jeux de données :
{
"datasets": [
{
"timestamp": "2020-01-01T22:50:48.123Z",
"datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
"description": "Some description or comment for the dataset.",
"datasetSources": {
"udids": [
"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
}
},
{
"timestamp": "2020-01-01T22:57:53.123Z",
"datasetId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"description": "Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.",
"datasetSources": {
"conversionIds": [
"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c"
],
"udids": [
"15d21452-c9bb-27b6-5e79-743ca5c3205d"
]
"appendDatasetId": "46d1edb6-d29e-4786-9589-dbd4efd7a977"
},
"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?api-version=2023-03-01-preview
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Ce paramètre spécifie l’emplacement de la ressource Creator Azure Maps. Les valeurs valides sont us et eu. |
api-version
|
query | True |
string |
Numéro de version de l’API Azure Maps. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Spécifie quel compte est 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 |
La demande de jeu de données s’est terminée avec succès. Le corps de la réponse contient le jeu de données créé précédemment. |
|
Other Status Codes |
Une erreur inattendue s’est produite. |
Sécurité
AADToken
Il s’agit des flux OAuth2 Azure Active Directory . 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 uniques et des configurations Azure Active directory.
* 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.
- Actuellement, Azure Active Directory v1.0 ou v2.0 prend en charge les comptes professionnels, scolaires et invités, mais ne prend pas en charge les comptes personnels.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
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, 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
In:
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
In:
header
Exemples
List all the previously created datasets
Sample Request
GET https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview
Sample Response
{
"datasets": [
{
"created": "2021-05-21T03:04:05.678Z",
"datasetId": "{datasetId}",
"description": "Some description or comment for the dataset.",
"datasetSources": {
"udids": [
"{udid}"
]
},
"featureCounts": {
"directoryInfo": 1,
"category": 18,
"facility": 1,
"level": 6,
"unit": 775,
"opening": 471,
"areaElement": 496
},
"ontology": "facility-2.0"
},
{
"created": "2021-05-21T03:04:05.678Z",
"datasetId": "{datasetId}",
"description": "Some other description or comment for the dataset.",
"datasetSources": {
"conversionIds": [
"{conversionId}"
],
"udids": [
"{udid}"
],
"appendDatasetId": "{appendDatasetId}"
},
"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
Nom | Description |
---|---|
Dataset |
Informations détaillées pour le jeu de données. |
Dataset |
Modèle de réponse pour l’API Liste de jeux de données. Le corps de la réponse contient une liste de tous les jeux de données créés précédemment. |
Dataset |
Informations sur les détails de la demande de création du jeu de données. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Dataset
Informations détaillées pour le jeu de données.
Nom | Type | Description |
---|---|---|
created |
string |
Horodatage créé pour le jeu de données. |
datasetId |
string |
ID du jeu de données. |
datasetSources |
Informations sur les détails de la demande de création du jeu de données. |
|
description |
string |
Description du jeu de données. |
featureCounts |
object |
Nombre de fonctionnalités pour le jeu de données. |
ontology |
string |
Version d’ontologie de ce jeu de données. |
DatasetListResult
Modèle de réponse pour l’API Liste de jeux de données. Le corps de la réponse contient une liste de tous les jeux de données créés précédemment.
Nom | Type | Description |
---|---|---|
datasets |
Dataset[] |
Liste de tous les jeux de données créés précédemment. |
nextLink |
string |
Le cas échéant, l’emplacement de la page de données suivante. |
DatasetSources
Informations sur les détails de la demande de création du jeu de données.
Nom | Type | Description |
---|---|---|
appendDatasetId |
string |
Jeu de données ajouté pour créer le jeu de données actuel. |
conversionIds |
string[] |
|
udids |
string[] |
|
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 |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur. |