You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-maps/how-to-create-data-registries.md
+39-31Lines changed: 39 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,24 +16,24 @@ The [data registry] service enables you to register data content in an Azure Sto
16
16
17
17
## Prerequisites
18
18
19
-
-[Azure Maps account]
20
-
-[Subscription key]
21
-
- An [Azure storage account][create storage account]
19
+
-An [Azure Maps account]
20
+
-A [Subscription key]
21
+
- An [Azure storage account]
22
22
23
23
>[!IMPORTANT]
24
24
>
25
-
> - 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).
25
+
> - 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].
26
26
> - In the URL examples in this article you will need to replace:
27
27
> -`{Azure-Maps-Subscription-key}` with your Azure Maps [subscription key].
28
-
> -`{udid}` with the user data ID of your data registry. For more information, see [The user data ID](#the-user-data-id).
28
+
> -`{udid}` with the user data ID of your data registry. For more information, see [The user data ID].
29
29
30
30
## Prepare to register data in Azure Maps
31
31
32
32
Before you can register data in Azure Maps, you need to create an environment containing all 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.
33
33
34
34
### Create managed identities
35
35
36
-
There are two types of managed identities: **system-assigned** and **user-assigned**. System-assigned managed identities have their lifecycle tied to the resource that created them. User-assigned managed identities can be used on multiple resources. For more information, see [managed identities for Azure resources][managed identity].
36
+
There are two types of managed identities: **system-assigned** and **user-assigned**. System-assigned managed identities have their lifecycle tied to the resource that created them. User-assigned managed identities can be used on multiple resources. For more information, see [managed identities for Azure resources].
37
37
38
38
Use the following steps to create a managed identity, add it to your Azure Maps account.
39
39
@@ -68,7 +68,7 @@ The user defined managed identity should now be added to your Azure Maps account
68
68
69
69
---
70
70
71
-
For more information, see [managed identities for Azure resources][managed identity].
71
+
For more information, see [managed identities for Azure resources].
72
72
73
73
### Create a container and upload data files
74
74
@@ -98,9 +98,10 @@ To create a container in the [Azure portal], follow these steps:
98
98
Once you've created an Azure storage account with files uploaded into one or more containers, you're ready to create the datastore that links the storage accounts to your Azure Maps account.
99
99
100
100
> [!IMPORTANT]
101
-
> All storage accounts linked to an Azure Maps account must be in the same geographic location. For more information, see [Azure Maps service geographic scope][geographic scope].
101
+
> All storage accounts linked to an Azure Maps account must be in the same geographic location. For more information, see [Azure Maps service geographic scope].
102
+
102
103
> [!NOTE]
103
-
> If you do not have a storage account see [Create a storage account][create storage account].
104
+
> If you do not have a storage account see [Create a storage account].
104
105
105
106
1. Select **Datastore** from the left menu in your Azure Maps account.
106
107
1. Select the **Add** button. An **Add datastore** screen appears on the right side.
@@ -132,7 +133,7 @@ To assign roles to your managed identities and associate them with a datastore:
132
133
133
134
With a datastore created in your Azure Maps account, you're ready to gather the properties required to create the data registry.
134
135
135
-
There are the AzureBlob properties that you pass in the body of the HTTP request, and [The user data ID](#the-user-data-id) passed in the URL.
136
+
There are the AzureBlob properties that you pass in the body of the HTTP request, and [The user data ID] passed in the URL.
136
137
137
138
### The AzureBlob
138
139
@@ -146,11 +147,11 @@ The `AzureBlob` is a JSON object that defines properties required to create the
146
147
|`linkedResource`| The ID of the datastore registered in the Azure Maps account.<BR>The datastore contains a link to the file being registered. |
147
148
|`blobUrl`| A URL pointing to the Location of the AzurebBlob, the file imported into your container. |
148
149
149
-
The following two sections provide you with details how to get the values to use for the [msiClientId](#the-msiclientid-property), [blobUrl](#the-bloburl-property) properties.
150
+
The following two sections provide you with details how to get the values to use for the [msiClientId], [blobUrl] properties.
150
151
151
152
#### The msiClientId property
152
153
153
-
The `msiClientId` property is the ID of the managed identity used to create the data registry. There are two types of managed identities: **system-assigned** and **user-assigned**. System-assigned managed identities have their lifecycle tied to the resource that created them. User-assigned managed identities can be used on multiple resources. For more information, see [What are managed identities for Azure resources?][managed identity].
154
+
The `msiClientId` property is the ID of the managed identity used to create the data registry. There are two types of managed identities: **system-assigned** and **user-assigned**. System-assigned managed identities have their lifecycle tied to the resource that created them. User-assigned managed identities can be used on multiple resources. For more information, see [managed identities for Azure resources].
154
155
155
156
# [system-assigned](#tab/System-assigned)
156
157
@@ -192,7 +193,7 @@ The user data ID (`udid`) of the data registry is a user-defined GUID that must
192
193
```
193
194
194
195
> [!TIP]
195
-
> The `udid` is a user-defined GUID that must be supplied when creating a data registry. If you want to be certain you have a globally unique identifier (GUID), consider creating it by running a GUID generating tool such as the Guidgen.exe command line program (Available with [Visual Studio][Visual Studio]).
196
+
> The `udid` is a user-defined GUID that must be supplied when creating a data registry. If you want to be certain you have a globally unique identifier (GUID), consider creating it by running a GUID generating tool such as the Guidgen.exe command line program (Available with [Visual Studio]).
196
197
197
198
## Create a data registry
198
199
@@ -221,7 +222,7 @@ To create a data registry:
221
222
> [!NOTE]
222
223
> When using System-assigned managed identities, you will get an error if you provide a value for the msiClientId property in your HTTP request.
223
224
224
-
For more information on the properties required in the HTTP request body, see [Data registry properties](#data-registry-properties).
225
+
For more information on the properties required in the HTTP request body, see [Data registry properties].
225
226
226
227
1. Once you have the body of your HTTP request ready, execute the following **HTTP PUT request**:
227
228
@@ -230,7 +231,7 @@ To create a data registry:
230
231
231
232
```
232
233
233
-
For more information on the `udid` property, see [The user data ID](#the-user-data-id).
234
+
For more information on the `udid` property, see [The user data ID].
234
235
235
236
1. Copy the value of the **Operation-Location** key from the response header.
236
237
@@ -253,7 +254,7 @@ To create a data registry:
253
254
> [!NOTE]
254
255
> When using User-assigned managed identities, you will get an error if you don't provide a value for the msiClientId property in your HTTP request.
255
256
256
-
For more information on the properties required in the HTTP request body, see [Data registry properties](#data-registry-properties).
257
+
For more information on the properties required in the HTTP request body, see [Data registry properties].
257
258
258
259
1. Once you have the body of your HTTP request ready, execute the following **HTTP PUT request**:
259
260
@@ -262,30 +263,30 @@ To create a data registry:
262
263
263
264
```
264
265
265
-
For more information on the `udid` property, see [The user data ID](#the-user-data-id).
266
+
For more information on the `udid` property, see [The user data ID].
266
267
267
268
1. Copy the value of the **Operation-Location** key from the response header.
268
269
269
270
---
270
271
271
272
> [!TIP]
272
-
> If the contents of a previously registered file is modified, it will fail its [data validation](#data-validation) and won't be usable in Azure Maps until it's re-registered. To re-register a file, rerun the register request, passing in the same [AzureBlob](#the-azureblob) used to create the original registration.
273
-
The value of the **Operation-Location** key is the status URL that you'll use to check the status of the data registry creation in the next section, it contains the operation ID used by the [Get operation][Get operation] API.
273
+
> If the contents of a previously registered file is modified, it will fail its [data validation] and won't be usable in Azure Maps until it's re-registered. To re-register a file, rerun the register request, passing in the same [AzureBlob] used to create the original registration.
274
+
The value of the **Operation-Location** key is the status URL that you'll use to check the status of the data registry creation in the next section, it contains the operation ID used by the [Get operation] API.
274
275
275
276
> [!NOTE]
276
277
> The value of the **Operation-Location** key will not contain the `subscription-key`, you will need to add that to the request URL when using it to check the data registry creation status.
277
278
278
279
### Check the data registry creation status
279
280
280
-
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:
281
+
To (optionally) check the status of the data registry creation process, enter the status URL you copied in the [Create a data registry] section, and add your subscription key as a query string parameter. The request should look similar to the following URL:
| contentMD5 | MD5 hash created from the contents of the file being registered. For more information, see [Data validation](#data-validation)|
351
+
| contentMD5 | MD5 hash created from the contents of the file being registered. For more information, see [Data validation]|
351
352
| sizeInBytes | The size of the content in bytes. |
352
353
353
354
## Replace a data registry
354
355
355
-
If you need to replace a previously registered file with another file, rerun the register request, passing in the same [AzureBlob](#the-azureblob) used to create the original registration, except for the [blobUrl](#the-bloburl-property). The `BlobUrl` needs to be modified to point to the new file.
356
+
If you need to replace a previously registered file with another file, rerun the register request, passing in the same [AzureBlob] used to create the original registration, except for the [blobUrl]. The `BlobUrl` needs to be modified to point to the new file.
356
357
357
358
## Data validation
358
359
359
360
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 fails. If you need to modify the contents of a file that has been registered in Azure Maps, you need to register it again.
0 commit comments