Data - Delete Preview
The Delete request allows the caller to delete data previously uploaded using Data Upload.
Applies to: S1 pricing tier.
This API allows the caller to delete a previously uploaded data content.
You can use this API in a scenario like removing geofences previously uploaded using the Data Upload API for use in our Azure Maps Geofencing Service. You can also use this API to delete old/unused uploaded content and create space for new content.
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.
Submit Delete Request
To delete your content you will issue a DELETE
request where the path will contain the udid
of the data to delete.
For example, to delete a collection of geofences previously uploaded using the Upload API, set the udid
parameter in the path to the udid
of the data received previously in the upload API response.
Delete Data Response
The Data Delete API returns a HTTP 204 No Content
response with an empty body, if the data resource was deleted successfully.
A HTTP 400 Bad Request
error response will be returned if the data resource with the passed-in udid
is not found.
DELETE https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=1.0
DELETE https://{geography}.atlas.microsoft.com/mapData/{udid}?subscription-key={subscription-key}&api-version=1.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. |
udid
|
path | True |
string |
The unique data id for the content. The |
api-version
|
query | True |
string |
Version number of Azure Maps API. Current version is 1.0 |
subscription-key
|
query |
string |
One of the Azure Maps keys provided from an Azure Map Account. Please refer to this article for details on how to manage authentication. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following articles for guidance. |
Responses
Name | Type | Description |
---|---|---|
204 No Content |
object |
Data delete request completed successfully. The content for |
400 Bad Request |
Bad request: one or more parameters were incorrectly specified or are mutually exclusive. |
|
401 Unauthorized |
Access denied due to invalid subscription key or invalid Microsoft Entra ID bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the WWW-Authenticate header for error code and description of the provided Microsoft Entra ID bearer token. Headers WWW-Authenticate: string |
|
403 Forbidden |
Permission, capacity, or authentication issues. |
|
404 Not Found |
Not Found: the requested resource could not be found, but it may be available again in the future. |
|
500 Internal Server Error |
An error occurred while processing the request. Please try again later. |
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
Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences
Sample Request
DELETE https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?subscription-key=[subscription-key]&api-version=1.0
Sample Response
{}
{
"error": {
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
{
"error": {
"code": "401 Unauthorized",
"message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}
}
{
"error": {
"code": "403 Forbidden",
"message": "Permission, capacity, or authentication issues."
}
}
{
"error": {
"code": "404 NotFound",
"message": "Not Found: the requested resource could not be found, but it may be available again in the future."
}
}
{
"error": {
"code": "500 InternalServerError",
"message": "An error occurred while processing the request. Please try again later."
}
}
Definitions
Name | Description |
---|---|
OData |
This object is returned when an error occurs in the Azure Maps API. |
OData |
This response object is returned when an error occurs in the Azure Maps API. |
ODataError
This object is returned when an error occurs in the Azure Maps API.
Name | Type | Description |
---|---|---|
code |
string |
The ODataError code. |
details |
This object is returned when an error occurs in the Azure Maps API. |
|
message |
string |
If available, a human-readable description of the error. |
target |
string |
If available, the target causing the error. |
ODataErrorResponse
This response object is returned when an error occurs in the Azure Maps API.
Name | Type | Description |
---|---|---|
error |
This object is returned when an error occurs in the Azure Maps API. |