Data - Get Operation

Reference

Service:: Maps

API Version:: 2.0

Use to check the status of a Data Upload request and get the udid value once completed.

Note

Azure Maps Data service retirement

The Azure Maps Data service (both v1 and v2) is now deprecated and will be retired on 9/16/24. To avoid service disruptions, all calls to the Data service will need to be updated to use the Azure Maps Data Registry service by 9/16/24. For more information, see How to create data registry.

The Get Operation API is an HTTP GET request that allows the caller to check the status of a Data Upload operation and get the udid value once completed. This path will be obtained from a call to POST /mapData. While in progress, an HTTP 200 response code will be returned with no extra headers - followed by an HTTP 200 response code with a Resource-Location header once successfully completed.

Important

By using this feature, you agree to the preview legal terms. See the Preview Supplemental Terms for additional details.

GET https://{geography}.atlas.microsoft.com/mapData/operations/{operationId}?api-version=2.0

URI Parameters

Name	In	Required	Type	Description
geography	path	True	string	This parameter specifies where the Azure Maps Creator resource is located. Valid values are us and eu.
operationId	path	True	string	The ID to query the status for the data upload request.
api-version	query	True	string	Version number of Azure Maps API.

Responses

Name	Type	Description
200 OK	LongRunningOperationResult	The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result. Headers Resource-Location: string
Other Status Codes	ErrorResponse	An unexpected error occurred.

Name

Type

Description

200 OK

LongRunningOperationResult

The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.

Headers

Resource-Location: string

Other Status Codes

ErrorResponse

An unexpected error occurred.

Security

AADToken

These are the Microsoft Entra OAuth 2.0 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

For more information on Microsoft identity platform, see Microsoft identity platform overview.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

This is a shared key that is provisioned when you Create an Azure Maps account in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.

With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.

For publicly exposed applications, our recommendation is to use the confidential client applications approach to access Azure Maps REST APIs so your key can be securely stored.

Type: apiKey
In: query

SAS Token

This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.

For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.

Type: apiKey
In: header

Examples

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

HTTP

GET https://us.atlas.microsoft.com/mapData/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

Sample Response

Status code:: 200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

Response Body

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

HTTP

GET https://us.atlas.microsoft.com/mapData/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

Sample Response

Status code:: 200

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-23T19:14:03.2452596+00:00",
  "status": "Running"
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
LongRunningOperationResult	The response model for a Long-Running Operations API.
LroStatus	The status state of the request.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

LongRunningOperationResult

The response model for a Long-Running Operations API.

Name	Type	Description
created	string	The created timestamp.
error	ErrorDetail	The error detail.
operationId	string	The Id for this long-running operation.
status	LroStatus	The status state of the request.
warning	ErrorDetail	The error detail.

LroStatus

The status state of the request.

Name	Type	Description
Failed	string	The request has one or more failures.
NotStarted	string	The request has not started processing yet.
Running	string	The request has started processing.
Succeeded	string	The request has successfully completed.

Data - Get Operation

URI Parameters

Responses

Security

AADToken

Notes

Scopes

subscription-key

SAS Token

Examples

Get the status of an operation which has finished successfully

Sample Request

Sample Response

Get the status of an operation which is still running

Sample Request

Sample Response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

Additional resources