Data Registry - Get Operation

Référence

Service:: Maps

API Version:: 2023-06-01

Utilisez pour case activée l’status de la demande de registre ou de remplacement de données.
L’API Get Operation est une requête HTTP GET utilisée pour obtenir la status d’un registre de données ou la demande de remplacement est retournée dans l’en-tête de la réponse de registre ou de remplacement en tant que 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ée.

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.

GET https://{geography}.atlas.microsoft.com/dataRegistries/operations/{operationId}?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 us (USA Est, USA Centre-Ouest, USA Ouest 2) et eu (Europe Nord, Europe Ouest).
operationId	path	True	string	ID utilisé pour interroger le status d’une demande de 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.

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

operationId

path

True

string

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

Réponses

Nom	Type	Description
200 OK	LongRunningOperationResult	Status de l’opération de longue durée. Headers Retry-After: integer
Other Status Codes	MapsErrorResponse	Une erreur inattendue s’est produite. Headers x-ms-error-code: string

Nom

Type

Description

200 OK

LongRunningOperationResult

Status de l’opération de longue durée.

Headers

Retry-After: integer

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.

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

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

Sample Request

HTTP

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

Sample Response

Status code:: 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

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Completed"
}

Get the status of an operation that is still running

Sample Request

HTTP

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

Sample Response

Status code:: 200

Retry-After: 10

Response Body

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

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	Status d’une opération de longue durée.

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.

Partager via

Data Registry - Get Operation

Paramètres URI

Réponses

Sécurité

AADToken

Notes

Scopes

subscription-key

SAS Token

Exemples

Get the status of an operation that failed

Sample Request

Sample Response

Get the status of an operation that finished successfully

Sample Request

Sample Response

Get the status of an operation that is still running

Sample Request

Sample Response

Définitions

LongRunningOperationResult

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Ressources supplémentaires