Partager via

Data Registry - Register Or Replace

  • Référence
Service:
Maps
API Version:
2023-06-01

Utilisez pour inscrire des données stockées dans un compte de stockage Azure avec un compte Azure Maps.

L’API Register est une requête HTTP PUT utilisée pour inscrire les données dans un compte de stockage Azure avec un compte Azure Maps. La taille maximale du fichier pouvant être inscrit est d’un gigaoctet.

Cela est utile dans des scénarios tels que l’inscription d’une collection de geofences au GeoJSON format pour une utilisation dans Azure Maps service de géorefencing ou l’inscription d’un ensemble de fichiers de conception DWG en tant que package de dessin compressé pour une utilisation dans le service de conversion Azure Maps Creator.

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 de Azure Maps globaux.

Envoyer une demande d’inscription ou de remplacement

Les Register requêtes et Replace sont des opérations de longue durée qui contiennent un objet JSON AzureBlob dans le corps de la requête qui définit les détails du registre de données.

PUT https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?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).
udid
 path True

string

ID de données utilisateur du registre de données.

Regex pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
api-version
 query True

string

Numéro de version de Azure Maps API.

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.
Operation-Id

string

ID d’opération, au format GUID.

Regex pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

Corps de la demande

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

DataRegistryKind

Type de Registre de données.

Réponses

Nom Type Description
200 OK

DataRegistry

Remplacement de ressource : la demande a été acceptée pour traitement.

Headers

  • Operation-Id: string
  • Operation-Location: string
201 Created

DataRegistry

Création de ressources : la demande a été acceptée pour traitement.

Headers

  • Operation-Id: string
  • Operation-Location: string
Other Status Codes

MapsErrorResponse

Une erreur inattendue s’est produite.

Headers

x-ms-error-code: string

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.

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 provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou 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 master clés du compte pour lequel elles sont émises.

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

Type: apiKey
In: 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 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

Register or replace a udid

Sample Request

PUT https://us.atlas.microsoft.com/dataRegistries/29a92cab-74af-49e7-a326-66898220aa9d?api-version=2023-06-01

{
  "description": "Contoso Geofence GeoJSON",
  "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/path.json"
  }
}

Sample Response

Status code:
201 
Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Response Body
{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "description": "Contoso Geofence GeoJSON",
  "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/path.json",
    "sizeInBytes": 1339
  },
  "status": "Running"
}
Status code:
200 
Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Response Body
{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "description": "Contoso Geofence GeoJSON",
  "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/path.json",
    "sizeInBytes": 1339
  },
  "status": "Running"
}

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

Status 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

Status 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

LongRunningOperationStatus

Status d’une opération de longue durée.

Nom Type Description
Completed

string

La demande s’est terminée avec succès.
Failed

string

La requête présente un ou plusieurs échecs.
Running

string

La demande est en cours de traitement.

MapsErrorDetail

Détail de l’erreur.

Nom Type Description
code

string

Un des codes d’erreur définis par le serveur.
details

MapsErrorDetail[]

Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror

MapsInnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message

string

Représentation lisible par l’homme de l’erreur.
target

string

Cible 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é.

Nom Type Description
error

MapsErrorDetail

Détail de l’erreur.

MapsInnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

Nom Type Description
code

string

Code d'erreur.
innererror

MapsInnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.