Skip to content

Commit 07018f2

Browse files
committed
addressed review feedback from Azure Docs team
1 parent 035f9b9 commit 07018f2

File tree

4 files changed

+28
-36
lines changed

4 files changed

+28
-36
lines changed

articles/azure-maps/how-to-create-data-registries.md

Lines changed: 28 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Create Data Registry (preview)
33
titleSuffix: Azure Maps
44
description: Learn how to create Data Registry.
55
author: stevemunk
6-
ms.author: v-munksteve
6+
ms.author: eriklind
77
ms.date: 2/14/2023
88
ms.topic: how-to
99
ms.service: azure-maps
@@ -12,22 +12,22 @@ services: azure-maps
1212

1313
# How to create data registry (preview)
1414

15-
The [data registry][data registry] service enables you to register data content in an Azure Storage Account with your Azure Maps account. An example of data might include a collection of Geofences used in the Azure Maps Geofencing Service. Another example is ZIP files containing drawing packages (DWG) or GeoJSON files that Azure Maps Creator uses to create or update indoor maps.
15+
The [data registry] service enables you to register data content in an Azure Storage Account with your Azure Maps account. An example of data might include a collection of Geofences used in the Azure Maps Geofencing Service. Another example is ZIP files containing drawing packages (DWG) or GeoJSON files that Azure Maps Creator uses to create or update indoor maps.
1616

1717
## Prerequisites
1818

19-
- [Azure Maps account][Azure Maps account].
20-
- [Subscription key][subscription key].
21-
- An [Azure storage account][create storage account].
19+
- [Azure Maps account]
20+
- [Subscription key]
21+
- An [Azure storage account][create storage account]
2222

2323
>[!IMPORTANT]
2424
>
2525
> - This article uses the `us.atlas.microsoft.com` geographical URL. If your account wasn't created in the United States, you must use a different geographical URL. For more information, see [Access to Creator Services](how-to-manage-creator.md#access-to-creator-services).
2626
> - In the URL examples in this article you will need to replace:
27-
> - `{Azure-Maps-Subscription-key}` with your Azure Maps [subscription key][subscription key].
27+
> - `{Azure-Maps-Subscription-key}` with your Azure Maps [subscription key].
2828
> - `{udid}` with the user data ID of your data registry. For more information, see [The user data ID](#the-user-data-id).
2929
30-
## Preparing to register data in Azure Maps
30+
## Prepare to register data in Azure Maps
3131

3232
Before you can register data in Azure Maps, you need to create an environment containing all of the required components. You need a storage account with one or more containers that hold the files you wish to register and managed identities for authentication. This section explains how to prepare your Azure environment to register data in Azure Maps.
3333

@@ -41,15 +41,15 @@ Use the following steps to create a managed identity, add it to your Azure Maps
4141

4242
Create a system assigned managed identity:
4343

44-
1. Go to your Azure Maps account in the [Azure portal][Azure portal].
44+
1. Go to your Azure Maps account in the [Azure portal].
4545
1. Select **Identity** from the left menu.
4646
1. Toggle the **Status** to **On**.
4747

4848
# [user-assigned](#tab/User-assigned)
4949

5050
Create a user assigned managed identity:
5151

52-
1. Go to the [Azure portal][Azure portal] and select **Create a resource**.
52+
1. Go to the [Azure portal] and select **Create a resource**.
5353
1. In the **Search services and marketplace** control, enter **user assigned managed identity**.
5454
1. In the **Create User Assigned Managed Identity** page, select your subscription, resource group, region and a name for your managed identify.
5555
1. Select **Review + create**, then once ready, **Create**.
@@ -62,7 +62,7 @@ Create a user assigned managed identity:
6262
1. In the **Add user assigned managed identity** screen, select the desired **Subscription** and managed identity.
6363
1. Select **Add**
6464

65-
:::image type="content" source="./media/data-registry/add-user-assigned-managed-identity.png" lightbox="./media/data-registry/add-user-assigned-managed-identity.png" alt-text="Add user assigned managed identity screenshot.":::
65+
:::image type="content" source="./media/data-registry/add-user-assigned-managed-identity.png" lightbox="./media/data-registry/add-user-assigned-managed-identity.png" alt-text="A screenshot that demonstrates how to add a user assigned managed identity.":::
6666

6767
The user defined managed identity should now be added to your Azure Maps account.
6868

@@ -74,7 +74,7 @@ For more information, see [managed identities for Azure resources][managed ident
7474

7575
Before adding files to a data registry, you must upload them into a container in your [Azure storage account][storage account overview]. Containers are similar to a directory in a file system, they're how your files are organized in your Azure storage account.
7676

77-
To create a container in the [Azure portal][Azure portal], follow these steps:
77+
To create a container in the [Azure portal], follow these steps:
7878

7979
1. From within your Azure storage account, select **Containers** from the **Data storage** section in the navigation pane.
8080
1. Select **+ Container** in the **Containers** pane to bring up the **New container** pane.
@@ -174,7 +174,7 @@ The value used for the `msiClientId` property is the client ID of a user assigne
174174
#### The blobUrl property
175175

176176
The `blobUrl` property is the path to the file being registered. You can get this value from the container that it was added to.
177-
177+
[data registry]
178178
1. Select your **storage account** in the **Azure portal**.
179179
1. Select **Containers** from the left menu.
180180
1. A list of containers will appear. Select the container that contains the file you wish to register.
@@ -196,7 +196,7 @@ The user data ID (`udid`) of the data registry is a user-defined GUID that must
196196
197197
## Create a data registry
198198

199-
Now that you have your storage account with the desired files linked to your Azure Maps account through the datastore and have gathered all required properties, you're ready to use the [data registry][data registry] API to register those files. If you have multiple files in your Azure storage account that you want to register, you'll need to run the register request for each file (`udid`).
199+
Now that you have your storage account with the desired files linked to your Azure Maps account through the datastore and have gathered all required properties, you're ready to use the [data registry] API to register those files. If you have multiple files in your Azure storage account that you want to register, you'll need to run the register request for each file (`udid`).
200200

201201
> [!NOTE]
202202
> The maximum size of a file that can be registered with an Azure Maps datastore is one gigabyte.
@@ -238,24 +238,19 @@ The value of the **Operation-Location** key is the status URL that you'll use to
238238

239239
### Check the data registry creation status
240240

241-
To (optionally) check the status of the data registry creation process:
242-
243-
1. Enter the status URL you copied in the [Create a data registry](#create-a-data-registry) section, and add your subscription key as a query string parameter. The request should look similar to the following URL:
241+
To (optionally) check the status of the data registry creation process, enter the status URL you copied in the [Create a data registry](#create-a-data-registry) section, and add your subscription key as a query string parameter. The request should look similar to the following URL:
244242

245-
```http
246-
https://us.atlas.microsoft.com/dataRegistries/operations/{udid}?api-version=2022-12-01-preview&subscription-key={Your-Azure-Maps-Primary-Subscription-key}
247-
```
243+
```http
244+
https://us.atlas.microsoft.com/dataRegistries/operations/{udid}?api-version=2022-12-01-preview&subscription-key={Your-Azure-Maps-Primary-Subscription-key}
245+
```
248246

249247
## Get a list of all files in the data registry
250248

251249
To get a list of all files registered in an Azure Maps account using the [List][list] request:
252250

253-
1. Execute the following **HTTP GET request**:
254-
255-
```http
256-
https://us.atlas.microsoft.com/dataRegistries?api-version=2022-12-01-preview&subscription-key={Azure-Maps-Subscription-key}
257-
258-
```
251+
```http
252+
https://us.atlas.microsoft.com/dataRegistries?api-version=2022-12-01-preview&subscription-key={Azure-Maps-Subscription-key}
253+
```
259254

260255
The following is a sample response showing three possible statuses, completed, running and failed:
261256

@@ -324,14 +319,11 @@ The data returned when running the list request is similar to the data provided
324319

325320
Once you've uploaded one or more files to an Azure storage account, created and Azure Maps datastore to link to those files, then registered them using the [register][register or replace] API, you can access the data contained in the files.
326321

327-
To get the content of a file registered in an Azure Maps account:
322+
Use the `udid` to get the content of a file registered in an Azure Maps account:
328323

329-
1. Using the `udid` of the file you want to access, execute the following **HTTP GET request**:
330-
331-
```http
332-
https://us.atlas.microsoft.com/dataRegistries/{udid}/content?api-version=2022-12-01-preview&subscription-key={Azure-Maps-Subscription-key}
333-
334-
```
324+
```http
325+
https://us.atlas.microsoft.com/dataRegistries/{udid}/content?api-version=2022-12-01-preview&subscription-key={Azure-Maps-Subscription-key}
326+
```
335327

336328
The contents of the file will appear in the body of the response. For example, a text based GeoJSON file will appear similar to the following example:
337329

@@ -369,10 +361,10 @@ If you need to replace a previously registered file with another file, rerun the
369361

370362
When you register a file in Azure Maps using the data registry API, an MD5 hash is created from the contents of the file, encoding it into a 128-bit fingerprint and saving it in the `AzureBlob` as the `contentMD5` property. The MD5 hash stored in the `contentMD5` property is used to ensure the data integrity of the file. Since the MD5 hash algorithm always produces the same output given the same input, the data validation process can compare the `contentMD5` property of the file when it was registered against a hash of the file in the Azure storage account to check that it's intact and unmodified. If the hash isn't the same, the validation fails. If the file in the underlying storage account changes, the validation will fail. If you need to modify the contents of a file that has been registered in Azure Maps, you'll need to register it again.
371363

372-
[data registry]: /rest/api/maps/2022-12-01-preview/data-registry
373-
[list]: /rest/api/maps/2022-12-01-preview/data-registry/list
374-
[Register Or Replace]: /rest/api/maps/2022-12-01-preview/data-registry/register-or-replace
375-
[Get operation]: /rest/api/maps/2022-12-01-preview/data-registry/get-operation
364+
[data registry]: /rest/api/maps/data-registry
365+
[list]: /rest/api/maps/data-registry/list
366+
[Register Or Replace]: /rest/api/maps/data-registry/register-or-replace
367+
[Get operation]: /rest/api/maps/data-registry/get-operation
376368

377369
[Azure Maps account]: quick-demo-map-app.md#create-an-azure-maps-account
378370
[storage account overview]: /azure/storage/common/storage-account-overview
3.07 KB
Loading
4.61 KB
Loading
5.71 KB
Loading

0 commit comments

Comments
 (0)