Data Registry - Get Operation

Reference

Service:: Maps

API Version:: 2023-06-01

Use to check the status of the data register or replace request.
The Get Operation API is an HTTP GET request used to get the status of a data register or replace request is returned in the header of the register or replace response as the value of the Operation-Location key. While in progress, a HTTP 200 OK response will be returned with Retry-After header - followed by a HTTP 200 OK with no extra header once completed.

The data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.

GET https://{geography}.atlas.microsoft.com/dataRegistries/operations/{operationId}?api-version=2023-06-01

URI Parameters

Name In Required Type Description

Name	In	Required	Type	Description
geography	path	True	string	This parameter specifies where the Azure Maps Account is located. Valid values are us (East US, West Central US, West US 2) and eu (North Europe, West Europe).
operationId	path	True	string	The ID used to query the status of a data register request. 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	The version number of Azure Maps API.

geography

path

True

string

This parameter specifies where the Azure Maps Account is located. Valid values are us (East US, West Central US, West US 2) and eu (North Europe, West Europe).

operationId

path

True

string

The ID used to query the status of a data register request.

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

The version number of Azure Maps API.

Responses

Name	Type	Description
200 OK	LongRunningOperationResult	The status of the long-running operation. Headers Retry-After: integer
Other Status Codes	MapsErrorResponse	An unexpected error occurred. Headers x-ms-error-code: string

Name

Type

Description

200 OK

LongRunningOperationResult

The status of the long-running operation.

Headers

Retry-After: integer

Other Status Codes

MapsErrorResponse

An unexpected error occurred.

Headers

x-ms-error-code: string

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 creating an Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account they are issued for.

For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.

Type: apiKey
In: header

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

Definitions

Name	Description
LongRunningOperationResult	The response model for a long-running operation.
LongRunningOperationStatus	The status of a long-running operation.
MapsErrorDetail	The error detail.
MapsErrorResponse	Common error response for Azure Maps APIs to return error details for failed operations.
MapsInnerError	An object containing more specific information than the current object about the error.

LongRunningOperationResult

The response model for a long-running operation.

Name	Type	Description
error	MapsErrorDetail	The error detail.
id	string	The operationId
status	LongRunningOperationStatus	The status of a long-running operation.

LongRunningOperationStatus

The status of a long-running operation.

Name	Type	Description
Completed	string	The request completed successfully.
Failed	string	The request has one or more failures.
Running	string	The request is currently processing.

MapsErrorDetail

The error detail.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	MapsErrorDetail[]	An array of details about specific errors that led to this reported error.
innererror	MapsInnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

MapsErrorResponse

Common error response for Azure Maps APIs to return error details for failed operations.

Name	Type	Description
error	MapsErrorDetail	The error detail.

MapsInnerError

An object containing more specific information than the current object about the error.

Name	Type	Description
code	string	The error code.
innererror	MapsInnerError	An object containing more specific information than the current object about the error.

Data Registry - Get Operation

URI Parameters

Responses

Security

AADToken

Notes

Scopes

subscription-key

SAS Token

Examples

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

Definitions

LongRunningOperationResult

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Additional resources