Data Registry - Register Or Replace

Référence

Service:: Maps

Version d'API:: 2023-06-01

Utilisez pour inscrire des données stockées dans un compte de stockage Azure auprès d’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 auprès d’un compte Azure Maps. La taille de fichier maximale pouvant être enregistrée est d’un gigaoctet.

Cela est utile dans des scénarios tels que l’inscription d’une collection de limites géographiques au GeoJSON format pour une utilisation dans le service de géofencing Azure Maps 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 de créateur Azure Maps.

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

Envoyer une demande d’inscription ou de remplacement

Les Register requêtes et Replace sont toutes deux 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

Nom	Dans	Obligatoire	Type	Description
geography	path	True	string	Ce paramètre spécifie l’emplacement du compte Azure Maps. Les valeurs valides sont nous (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. Modèle d’expression régulière: `^[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 l’API Azure Maps.

geography

path

True

string

Ce paramètre spécifie l’emplacement du compte Azure Maps. Les valeurs valides sont nous (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.

Modèle d’expression régulière: ^[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 l’API Azure Maps.

En-tête de la demande

Nom Obligatoire Type Description

x-ms-client-id

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité d’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.
Operation-Id		string	ID d’opération, au format GUID. Modèle d’expression régulière: `^[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}$`

string

Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité d’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.

Operation-Id

string

ID d’opération, au format GUID.

Modèle d’expression régulière: ^[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 la ressource : la demande a été acceptée pour traitement. En-têtes Operation-Id: string Operation-Location: string
201 Created	DataRegistry	Création de ressource : la demande a été acceptée pour traitement. En-têtes Operation-Id: string Operation-Location: string
Other Status Codes	MapsErrorResponse	Une erreur inattendue s’est produite. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

DataRegistry

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

En-têtes

Operation-Id: string
Operation-Location: string

201 Created

DataRegistry

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

En-têtes

Operation-Id: string
Operation-Location: string

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.

est Authorization URL 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, 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 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, celles-ci 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 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 Répertorier les SAP sur la ressource Azure Maps via le plan de gestion Azure via le 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

Register or replace a udid

Exemple de requête

HTTP

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"
  }
}

Exemple de réponse

Code d’état:: 201

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

{
  "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"
}

Code d’état:: 200

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

{
  "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	État d’une opération de longue durée.
MapsErrorDetail	Détail de l’erreur.
MapsErrorResponse	Réponse d’erreur courante pour que les API Azure Maps retournent les détails de l’erreur en cas d’échec des opérations.
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 de l’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

LongRunningOperationStatus

État 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 ensembles de 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 de l’erreur.
target	string	Cible de l’erreur.

MapsErrorResponse

Réponse d’erreur courante pour que les API Azure Maps retournent les détails de l’erreur en cas d’échec des opérations.

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.

Partager via

Data Registry - Register Or Replace

Envoyer une demande d’inscription ou de remplacement

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

AADToken

Notes

Étendues

subscription-key

SAS Token

Exemples

Register or replace a udid

Exemple de requête

Exemple de réponse

Définitions

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Ressources supplémentaires