Data - Get Operation
Utilisez pour case activée le status d’une demande de chargement de données et obtenir la udid
valeur une fois terminée.
Notes
Retrait du service de données Azure Maps
Le service Data Azure Maps (v1 et v2) est désormais déconseillé et sera mis hors service le 16/09/2024. Pour éviter les interruptions de service, tous les appels au service Data devront être mis à jour pour utiliser le service Data Registry d’Azure Maps avant le 16/09/2024. Pour plus d'informations, consultez Guide pratique pour créer un registre de données.
L’API Get Operation
est une requête HTTP GET
qui permet à l’appelant de case activée la status d’une opération de chargement de données et d’obtenir la valeur une fois terminéeudid
. Ce chemin d’accès est obtenu à partir d’un appel à POST /mapData. En cours, un code de réponse HTTP 200 est retourné sans en-têtes supplémentaires, suivi d’un code de réponse HTTP 200 avec un Resource-Location
en-tête une fois terminé.
Important
En utilisant cette fonctionnalité, vous acceptez les conditions légales de la préversion. Pour plus d’informations, consultez les conditions supplémentaires en préversion .
GET https://{geography}.atlas.microsoft.com/mapData/operations/{operationId}?api-version=2.0
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. |
operation
|
path | True |
string |
ID permettant d’interroger le status pour la demande de chargement de données. |
api-version
|
query | True |
string |
Numéro de version de l’API Azure Maps. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
L’opération est en cours d’exécution ou terminée. Si l’opération a réussi, utilisez l’en-tête Resource-Location pour obtenir le chemin d’accès au résultat. Headers Resource-Location: string |
|
Other Status Codes |
Une erreur inattendue s’est produite. |
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
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 Create 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
Get the status of an operation which has finished successfully |
Get the status of an operation which is still running |
Get the status of an operation which has finished successfully
Sample Request
GET https://us.atlas.microsoft.com/mapData/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0
Sample Response
Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0
{
"operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"created": "2021-04-20T22:43:14.9401559+00:00",
"status": "Succeeded"
}
Get the status of an operation which is still running
Sample Request
GET https://us.atlas.microsoft.com/mapData/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0
Sample Response
{
"operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"created": "2021-04-23T19:14:03.2452596+00:00",
"status": "Running"
}
Définitions
Nom | Description |
---|---|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Long |
Modèle de réponse pour une API Operations Long-Running. |
Lro |
État status de la demande. |
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. |
LongRunningOperationResult
Modèle de réponse pour une API Operations Long-Running.
Nom | Type | Description |
---|---|---|
created |
string |
Horodatage créé. |
error |
Détail de l’erreur. |
|
operationId |
string |
ID de cette opération de longue durée. |
status |
État status de la demande. |
|
warning |
Détail de l’erreur. |
LroStatus
État status de la demande.
Nom | Type | Description |
---|---|---|
Failed |
string |
La requête présente un ou plusieurs échecs. |
NotStarted |
string |
Le traitement de la demande n’a pas encore commencé. |
Running |
string |
Le traitement de la demande a commencé. |
Succeeded |
string |
La demande s’est terminée avec succès. |