Partager via

Data Registry - Get Operation

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

Utilisez pour vérifier l’état du registre de données ou de la demande de remplacement .
L’API Get Operation est une requête HTTP GET utilisée pour obtenir l’état d’un registre de données ou la demande de remplacement est retournée dans l’en-tête de la réponse register ou replace comme valeur de la Operation-Location clé. En cours, une réponse HTTP 200 OK est retournée avec Retry-After un en-tête , suivi d’un http 200 OK sans en-tête supplémentaire une fois terminé.

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.

GET https://{geography}.atlas.microsoft.com/dataRegistries/operations/{operationId}?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 nous (USA Est, USA Centre-Ouest, USA Ouest 2) et eu (Europe Nord, Europe Ouest).
operationId
 path True

string

ID utilisé pour interroger l’état d’une demande de 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.

Réponses

Nom Type Description
200 OK

LongRunningOperationResult

État de l’opération de longue durée.

En-têtes

Retry-After: integer
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.

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

Get the status of an operation that failed
Get the status of an operation that finished successfully
Get the status of an operation that is still running

Get the status of an operation that failed

Exemple de requête

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Exemple de réponse

Code d’état:
200 
{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Failed",
  "error": {
    "code": "InvalidData",
    "message": "The data is not a valid GeoJSON."
  }
}

Get the status of an operation that finished successfully

Exemple de requête

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Exemple de réponse

Code d’état:
200 
{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Completed"
}

Get the status of an operation that is still running

Exemple de requête

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Exemple de réponse

Code d’état:
200 
Retry-After: 10
{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Running"
}

Définitions

Nom Description
LongRunningOperationResult

Modèle de réponse pour une opération de longue durée.
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.

LongRunningOperationResult

Modèle de réponse pour une opération de longue durée.

Nom Type Description
error

MapsErrorDetail

Détail de l’erreur.
id

string

OperationId
status

LongRunningOperationStatus

État d’une opération de longue durée.

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.