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/energy-data-services/how-to-manage-legal-tags.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,14 @@ ms.custom: template-how-to
10
10
---
11
11
12
12
# How to manage legal tags
13
-
In this article, you'll know how to manage legal tags in your Azure Data Manager for Energy instance. A Legal tag is the entity that represents the legal status of data in the Azure Data Manager for Energy instance. Legal tag is a collection of properties that governs how data can be ingested and consumed. A legal tag is required for data to be [ingested](concepts-csv-parser-ingestion.md) into your Azure Data Manager for Energy instance. It's also required for the [consumption](concepts-index-and-search.md) of the data from your Azure Data Manager for Energy instance. Legal tags are defined at a data partition level individually.
13
+
In this article, you'll know what legal tags are and how to manage them in your Azure Data Manager for Energy instance.
14
14
15
-
While in Azure Data Manager for Energy instance, [entitlement service](concepts-entitlements.md) defines access to data for a given user(s), legal tag defines the overall access to the data across users. A user may have access to manage the data within a data partition however, they may not be able to do so-until certain legal requirements are fulfilled.
15
+
A [legal tag](https://osdu.pages.opengroup.org/platform/security-and-compliance/legal/) is the entity that represents the legal status of data ingestion and [entitlement service](concepts-entitlements.md) defines user access to data. A user may have access to manage the data using entitlements but need to fulfill certain legal requirements using legal tags. Legal tag is a collection of required properties that governs how data can be [ingested](concepts-csv-parser-ingestion.md) into your Azure Data Manager for Energy instance.
16
+
17
+
The Azure Data Manager for Energy instance allows creation of legal tags only for `countryOfOrigin` that are allowed as per the configuration file [DefaultCountryCodes.json](https://community.opengroup.org/osdu/platform/security-and-compliance/legal/-/blob/master/legal-core/src/main/resources/DefaultCountryCode.json?ref_type=heads) at a data partition level. OSDU has defined this file and you can't edit it.
16
18
17
19
## Create a legal tag
18
-
Run the below curl command in Azure Cloud Bash to create a legal tag for a given data partition of your Azure Data Manager for Energy instance.
20
+
Run the curl command in Azure Cloud Bash to create a legal tag for a given data partition of your Azure Data Manager for Energy instance.
19
21
20
22
```bash
21
23
curl --location --request POST 'https://<URI>/api/legal/v1/legaltags' \
@@ -40,7 +42,7 @@ Run the below curl command in Azure Cloud Bash to create a legal tag for a given
40
42
```
41
43
42
44
### Sample request
43
-
Consider an Azure Data Manager for Energy instance named "medstest" with a data partition named "dp1"
45
+
Consider an Azure Data Manager for Energy instance named `medstest` with a data partition named "dp1":
44
46
45
47
```bash
46
48
curl --location --request POST 'https://medstest.energy.azure.com/api/legal/v1/legaltags' \
@@ -87,7 +89,7 @@ Consider an Azure Data Manager for Energy instance named "medstest" with a data
87
89
88
90
The country of origin should follow [ISO Alpha2 format](https://www.nationsonline.org/oneworld/country_code_list.htm).
89
91
90
-
The Create Legal Tag api, internally appends data-partition-id to legal tag name if it isn't already present. For instance, if request has name as: ```legal-tag```, then the create legal tag name would be ```<instancename>-<data-partition-id>-legal-tag```
92
+
This API internally appends `data-partition-id` to legal tag name if it isn't already present. For instance, if request has name as: ```legal-tag```, then the create legal tag name would be ```<instancename>-<data-partition-id>-legal-tag```.
91
93
92
94
```bash
93
95
curl --location --request POST 'https://medstest.energy.azure.com/api/legal/v1/legaltags' \
@@ -110,7 +112,7 @@ The Create Legal Tag api, internally appends data-partition-id to legal tag name
110
112
}'
111
113
112
114
```
113
-
The sample response will have data-partition-id appended to the legal tag name and sample response will be:
115
+
The sample response has `data-partition-id` appended to the legal tag name.
114
116
115
117
116
118
```JSON
@@ -133,7 +135,7 @@ The sample response will have data-partition-id appended to the legal tag name a
133
135
```
134
136
135
137
## Get a legal tag
136
-
Run the below curl command in Azure Cloud Bash to get the legal tag associated with a data partition of your Azure Data Manager for Energy instance.
138
+
Run the curl command in Azure Cloud Bash to get the legal tag associated with a data partition of your Azure Data Manager for Energy instance.
137
139
138
140
```bash
139
141
curl --location --request GET 'https://<URI>/api/legal/v1/legaltags/<legal-tag-name>' \
@@ -142,7 +144,7 @@ Run the below curl command in Azure Cloud Bash to get the legal tag associated w
142
144
```
143
145
144
146
### Sample request
145
-
Consider an Azure Data Manager for Energy instance named "medstest" with a data partition named "dp1"
147
+
Consider an Azure Data Manager for Energy instance named `medstest` with a data partition named "dp1":
146
148
147
149
```bash
148
150
curl --location --request GET 'https://medstest.energy.azure.com/api/legal/v1/legaltags/medstest-dp1-legal-tag' \
0 commit comments