Data Registry - List

Référence

Service:: Maps

Version d'API:: 2023-06-01

Utilisez pour obtenir la liste de tous les registres de données dans le compte Azure Maps.

L’API List est une requête HTTP GET qui retourne un tableau contenant tous les registres de données précédemment inscrits à l’aide de l’API Inscrire ou Remplacer.

Le point de terminaison de service du registre de données est limité à la région de votre compte Azure Maps et n’est pas disponible pour les comptes Azure Maps globaux.

Envoyer une demande de liste

Pour répertorier tous vos registres de données, émettez une GET demande sans paramètres supplémentaires.

Lister la réponse

La List demande retourne un tableau de registres de données au JSON format dans le corps de la réponse.

GET https://{geography}.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
geography	path	True	string	Ce paramètre spécifie l’emplacement du compte Azure Maps. Les valeurs valides sont us (USA Est, USA Centre-Ouest, USA Ouest 2) et eu (Europe Nord, Europe Ouest).
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é de l’ID Microsoft Entra. 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 la sécurité des ID Microsoft Entra dans Azure Maps, consultez les articles suivants pour obtenir des conseils.

Réponses

Nom Type Description

200 OK

Nom	Type	Description
200 OK	DataRegistryList	La `List` demande s’est terminée avec succès. Le corps de la réponse contient un tableau de registres de données.
Other Status Codes	MapsErrorResponse	Une erreur inattendue s’est produite. En-têtes x-ms-error-code: string

DataRegistryList

La List demande s’est terminée avec succès. Le corps de la réponse contient un tableau de registres de données.

Other Status Codes

MapsErrorResponse

Une erreur inattendue s’est produite.

En-têtes

x-ms-error-code: string

Sécurité

AADToken

Il s’agit des flux OAuth Microsoft Entra 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 aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Ou sous-ressources Azure Maps. 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 aux API REST Azure Maps.

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 à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les 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 la plateforme d’identités Microsoft, consultez Vue d’ensemble de la plateforme d’identités Microsoft.

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 lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.

Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, ces clés peuvent actuellement être traitées comme des clés principales du compte pour lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès de serveur à serveur des API REST Azure Maps, où cette clé peut être stockée en toute sécurité.

Type: apiKey
Dans: header

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 le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les 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

List all previously registered data registries

Exemple de requête

HTTP

GET https://us.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "description": "Contoso Indoor Design",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "zip",
        "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path1.zip",
        "sizeInBytes": 29920,
        "contentMD5": "CsFxZ2YSfxw3cRPlqokV0w=="
      },
      "status": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "geojson",
        "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path2.geojson",
        "sizeInBytes": 1339
      },
      "status": "Running"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "description": "Contoso Geofence GeoJSON",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "geojson",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path3.geojson",
        "sizeInBytes": 1650,
        "contentMD5": "rYpEfIeLbWZPyaICGEGy3A=="
      },
      "status": "Failed",
      "error": {
        "code": "ContentMD5Mismatch",
        "message": "Actual content MD5: sOJMJvFParkSxBsvvrPOMQ== doesn't match expected content MD5: CsFxZ2YSfxw3cRPlqokV0w==."
      }
    }
  ]
}

Définitions

Nom	Description
AzureBlob	Détails du registre de données d’objets blob Azure.
DataFormat	Format de données du contenu chargé utilisé à des fins de validation.
DataRegistry	Registre de données dans Azure Maps.
DataRegistryKind	Type de Registre de données.
DataRegistryList	Modèle de réponse pour l’API Liste du registre de données. Retourne une liste de toutes les données précédemment inscrites.
LongRunningOperationStatus	État d’une opération de longue durée.
MapsErrorDetail	Détail de l’erreur.
MapsErrorResponse	Réponse d’erreur courante pour les API Azure Maps pour retourner les détails de l’erreur pour les opérations ayant échoué.
MapsInnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

AzureBlob

Détails du registre de données d’objets blob Azure.

Nom	Type	Description
blobUrl	string	L’URL d’objet blob contient le chemin d’accès au fichier en cours d’inscription.
contentMD5	string	Contenu MD5 du contenu, utilisé pour la validation des données.
dataFormat	DataFormat	Format de données du contenu chargé utilisé à des fins de validation.
linkedResource	string	ID du magasin de données dans le compte Azure Maps.
msiClientId	string	ID client de l’identité managée affectée par l’utilisateur. Utilisez l’identité managée affectée par le système si elle n’est pas fournie.
sizeInBytes	integer	Taille du contenu en octets.

DataFormat

Format de données du contenu chargé utilisé à des fins de validation.

Nom	Type	Description
geojson	string	GeoJSON est un format d’échange de données géospatiales basé sur JSON.
zip	string	Format de données compressées.

DataRegistry

Registre de données dans Azure Maps.

Nom	Type	Description
azureBlob	AzureBlob	Détails du registre de données d’objets blob Azure.
description	string	Description donnée au registre de données. La longueur maximale est de 1 024 caractères.
error	MapsErrorDetail	Détail de l’erreur.
kind	DataRegistryKind	Type de Registre de données.
status	LongRunningOperationStatus	État d’une opération de longue durée.
udid	string	ID de données utilisateur pour le registre de données.

DataRegistryKind

Type de Registre de données.

Nom	Type	Description
AzureBlob	string	Objets blob Azure