Azure Maps Data Registry Service (stable:2023-06-01)

2025/10/06 • 5 deleted methods

DataRegistry_List (removed)
Description > [!NOTE] > > **Azure Maps Data registry service retirement** > > The Azure Maps Data registry service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Data Registry](https://aka.ms/AzureMapsDataRegistryDeprecation). The `List` API is an HTTP `GET` request that returns an array containing all data registries previously registered using the [Register or Replace API](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace). 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. ## Submit List Request To list all your data registries, issue a `GET` request with no additional parameters. ## List Response The `List` request returns an array of data registries in `JSON` format in the body of the response.
Reference Link ¶

⚼ Request

GET:  /dataRegistries
{
x-ms-client-id: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
udid: string ,
description: string ,
kind: enum ,
azureBlob:
{
dataFormat: enum ,
msiClientId: string ,
linkedResource: string ,
blobUrl: string ,
sizeInBytes: integer ,
contentMD5: string ,
}
,
status: enum ,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
DataRegistry_GetDataRegistry (removed)
Description > [!NOTE] > > **Azure Maps Data registry service retirement** > > The Azure Maps Data registry service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Data Registry](https://aka.ms/AzureMapsDataRegistryDeprecation). The `Get Data Registry` API is an HTTP `GET` request that returns data registry information, as an [AzureBlob](#azureblob) object in JSON format, in the body of the response, along with the HTTP status code 200, when successful. If Azure Maps cannot access the underlying content or the integrity check fails, the `status` is set to `Failed` and an error is returned. 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. ## Submit Get Data Registry Request A data registry `GET` request returns details of the requested data registry, as determined by the specified `udid`. The details are returned in the body of the response in JSON format.
Reference Link ¶

⚼ Request

GET:  /dataRegistries/{udid}
{
x-ms-client-id: string ,
api-version: string ,
udid: string ,
}

⚐ Response (200)

{
udid: string ,
description: string ,
kind: enum ,
azureBlob:
{
dataFormat: enum ,
msiClientId: string ,
linkedResource: string ,
blobUrl: string ,
sizeInBytes: integer ,
contentMD5: string ,
}
,
status: enum ,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
DataRegistry_RegisterOrReplace (removed)
Description > [!NOTE] > > **Azure Maps Data registry service retirement** > > The Azure Maps Data registry service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Data Registry](https://aka.ms/AzureMapsDataRegistryDeprecation). The `Register` API is an HTTP `PUT` request used to register the data in an Azure Storage Account with an Azure Maps account. The maximum file size that can be registered is one gigabyte. This is useful in scenarios like registering a collection of Geofences in `GeoJSON` format for use in [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or registering a set of DWG design files as a zipped [Drawing Package](https://docs.microsoft.com/azure/azure-maps/drawing-requirements) for use in the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion). 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. ## Submit Register or Replace Request The `Register` and `Replace` requests are both long-running operations that contain an [AzureBlob](#azureblob) JSON object in the body of the request that defines the data registry details.
Reference Link ¶

⚼ Request

PUT:  /dataRegistries/{udid}
{
x-ms-client-id: string ,
api-version: string ,
udid: string ,
Operation-Id: string ,
dataRegistry:
{
udid: string ,
description: string ,
kind: enum ,
azureBlob:
{
dataFormat: enum ,
msiClientId: string ,
linkedResource: string ,
blobUrl: string ,
sizeInBytes: integer ,
contentMD5: string ,
}
,
status: enum ,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-id: string ,
operation-location: string ,
}
,
$schema:
{
udid: string ,
description: string ,
kind: enum ,
azureBlob:
{
dataFormat: enum ,
msiClientId: string ,
linkedResource: string ,
blobUrl: string ,
sizeInBytes: integer ,
contentMD5: string ,
}
,
status: enum ,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
operation-id: string ,
operation-location: string ,
}
,
$schema:
{
udid: string ,
description: string ,
kind: enum ,
azureBlob:
{
dataFormat: enum ,
msiClientId: string ,
linkedResource: string ,
blobUrl: string ,
sizeInBytes: integer ,
contentMD5: string ,
}
,
status: enum ,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
DataRegistry_Unregister (removed)
Description > [!NOTE] > > **Azure Maps Data registry service retirement** > > The Azure Maps Data registry service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Data Registry](https://aka.ms/AzureMapsDataRegistryDeprecation). The `Unregister` API is an HTTP `DELETE` request that removes a data registry without deleting the underlying content from the Azure storage account. Useful in scenarios like unregistering geofence files previously registered using the [Register or Replace](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace) API for use in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or unregistering a compressed (ZIP) file containing DWG design files used by the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion). 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. ## Submit Unregister Request Use an HTTP `DELETE` request with the `udid` of the data registry to unregister. ## Unregister Response The `Unregister` request returns a HTTP '204 No Content' response with an empty body, if the data registry was deleted successfully.
Reference Link ¶

⚼ Request

DELETE:  /dataRegistries/{udid}
{
x-ms-client-id: string ,
api-version: string ,
udid: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
DataRegistry_GetOperation (removed)
Description > [!NOTE] > > **Azure Maps Data registry service retirement** > > The Azure Maps Data registry service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Data Registry](https://aka.ms/AzureMapsDataRegistryDeprecation). The `Get Operation` API is an HTTP `GET` request used to get the status of a [data register or replace](/rest/api/maps/data-registry/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.
Reference Link ¶

⚼ Request

GET:  /dataRegistries/operations/{operationId}
{
api-version: string ,
operationId: string ,
}

⚐ Response (200)

{
$headers:
{
retry-after: integer ,
}
,
$schema:
{
id: string ,
status: enum ,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}