Skip to content

Commit 4b48d4f

Browse files
authored
Merge pull request #247383 from danieljamescarpenter/dacarpen/updateSeismicTutorial
Update seismic tutorial and reduce duplicate screenshots
2 parents aa55b23 + b6bf98c commit 4b48d4f

11 files changed

+103
-39
lines changed
72 KB
Loading
160 KB
Loading
88.9 KB
Loading
78.8 KB
Loading
117 KB
Loading
76.3 KB
Loading

articles/energy-data-services/tutorial-seismic-ddms.md

Lines changed: 101 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -16,52 +16,116 @@ Seismic DDMS provides the capability to operate on seismic data in the Azure Dat
1616
In this tutorial, you will learn how to:
1717

1818
> [!div class="checklist"]
19-
> * Register data partition to seismic
20-
> * Utilize seismic DDMS Api's to store and retrieve seismic data
19+
> * Register a data partition for seismic data
20+
> * Utilize Seismic DDMS APIs to store and retrieve seismic data
2121
2222
## Prerequisites
2323

24-
### Azure Data Manager for Energy instance details
24+
- An Azure subscription
25+
- An instance of [Azure Data Manager for Energy](quickstart-create-microsoft-energy-data-services-instance.md) created in your Azure subscription.
2526

26-
* Once the [Azure Data Manager for Energy instance](./quickstart-create-microsoft-energy-data-services-instance.md) is created, note down the following details:
27-
28-
| Parameter | Value to use | Example |
29-
| ------------------ | ------------------------ |-------------------------------------- |
30-
| CLIENT_ID | Application (client) ID | 3dbbb..... |
31-
| CLIENT_SECRET | Client secrets | _fl****************** |
32-
| TENANT_ID | Directory (tenant) ID | 72f988bf-86f1-41af-91ab-2d7cd011db47 |
33-
| SCOPE | Application (client) ID | 3dbbb..... |
34-
| base_uri | URI | instancename.energy.azure.com |
35-
| data-partition-id | Data Partition(s) | instancename-datapartitionid |
27+
## Get your Azure Data Manager for Energy instance details
3628

37-
### Postman setup
29+
The first step is to get the following information from your [Azure Data Manager for Energy instance](quickstart-create-microsoft-energy-data-services-instance.md) in the [Azure portal](https://portal.azure.com/?microsoft_azure_marketplace_ItemHideKey=Microsoft_Azure_OpenEnergyPlatformHidden):
3830

39-
1. Download and install [Postman](https://www.postman.com/) desktop app
31+
| Parameter | Value | Example |
32+
| ------------------ | ------------------------ |-------------------------------------- |
33+
| client_id | Application (client) ID | 3dbbbcc2-f28f-44b6-a5ab-xxxxxxxxxxxx |
34+
| client_secret | Client secrets | _fl****************** |
35+
| tenant_id | Directory (tenant) ID | 72f988bf-86f1-41af-91ab-xxxxxxxxxxxx |
36+
| base_url | URL | `https://<instance>.energy.azure.com` |
37+
| data-partition-id | Data Partition(s) | `<data-partition-name>` |
38+
39+
## Set up Postman
40+
41+
1. Download and install the [Postman](https://www.postman.com/downloads/) desktop app.
4042
2. Import the following files into Postman:
41-
* To import the Postman collection and environment variables, follow the steps outlined in [Importing data into Postman](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/#importing-data-into-postman)
42-
* [Smoke test Postman collection](https://community.opengroup.org/osdu/platform/deployment-and-operations/infra-azure-provisioning/-/raw/master/source/ddms-smoke-tests/Azure%20DDMS%20OSDU%20Smoke%20Tests.postman_collection.json)
43-
* [Smoke Test Environment](https://community.opengroup.org/osdu/platform/deployment-and-operations/infra-azure-provisioning/-/raw/master/source/ddms-smoke-tests/%5BShip%5D%20osdu-glab.msft-osdu-test.org.postman_environment.json)
44-
45-
3. Update the **CURRENT_VALUE** of the Postman Environment with the information obtained in Azure Data Manager for Energy instance details
46-
47-
## Register data partition to seismic
48-
49-
* Script to register
50-
```sh
51-
curl --location --request POST '[url]/seistore-svc/api/v3/tenant/{{datapartition}}' \
52-
--header 'Authorization: Bearer {{TOKEN}}' \
53-
--header 'Content-Type: application/json' \
54-
--data-raw '{
55-
"esd": "{{datapartition}}.{{domain}}",
56-
"gcpid": "{{datapartition}}",
57-
"default_acl": "users.datalake.admins@{{datapartition}}.{{domain}}.com"
58-
}'
59-
```
60-
## Utilize seismic ddms API's to store and retrieve seismic data
61-
62-
In order to use the Seismic DMS, follow the steps in the Seismic DDMS SDUTIL tutorial.
43+
44+
* [Seismic DDMS Postman collection](https://raw.githubusercontent.com/microsoft/adme-samples/main/postman/SeismicDDMS.postman_collection.json)
45+
* [Seismic DDMS Postman environment](https://raw.githubusercontent.com/microsoft/adme-samples/main/postman/SeismicDDMSEnvironment.postman_environment.json)
46+
47+
To import the files:
48+
49+
1. Select **Import** in Postman.
50+
51+
:::image type="content" source="media/tutorial-ddms/postman-import-button.png" alt-text="Screenshot that shows the import button in Postman." lightbox="media/tutorial-ddms/postman-import-button.png":::
52+
53+
1. Paste the URL of each file into the search box.
54+
55+
:::image type="content" source="media/tutorial-ddms/postman-import-search.png" alt-text="Screenshot that shows importing collection and environment files in Postman via URL." lightbox="media/tutorial-ddms/postman-import-search.png":::
56+
57+
3. Update the **CURRENT_VALUE** of the Postman environment with the information obtained in Azure Data Manager for Energy instance details
58+
59+
## Utilize Seismic DDMS APIs to store and retrieve seismic data
60+
61+
### Create a legal tag
62+
63+
Create a legal tag that's automatically added to your Seismic DDMS environment for data compliance.
64+
65+
API: **Setup** > **Create Legal Tag for SDDMS**
66+
67+
Method: POST
68+
69+
:::image type="content" source="media/tutorial-seismic-ddms/postman-api-create-legal-tag.png" alt-text="Screenshot that shows the API that creates a legal tag." lightbox="media/tutorial-seismic-ddms/postman-api-create-legal-tag.png":::
70+
71+
For more information, see [Manage legal tags](how-to-manage-legal-tags.md).
72+
73+
### Service Verification
74+
75+
Run basic service connection and status tests in your Azure Data Manager for Energy instance.
76+
77+
API: **Service Verification** > **Check Access**
78+
79+
Method: GET
80+
81+
:::image type="content" source="media/tutorial-seismic-ddms/postman-api-check-service-status.png" alt-text="Screenshot that shows the API that checks the service's status." lightbox="media/tutorial-seismic-ddms/postman-api-check-service-status.png":::
82+
83+
### Tenant
84+
85+
Create a tenant in your Azure Data Manager for Energy instance.
86+
87+
**Note:** You must register a data partition as a tenant before using it with Seismic DDMS.
88+
89+
API: **Tenant** > **Register a Tenant**
90+
91+
Method: POST
92+
93+
:::image type="content" source="media/tutorial-seismic-ddms/postman-api-register-tenant.png" alt-text="Screenshot that shows the API that registers a tenant." lightbox="media/tutorial-seismic-ddms/postman-api-register-tenant.png":::
94+
95+
### Subproject
96+
97+
Create a subproject in your Azure Data Manager for Energy instance.
98+
99+
API: **Subproject** > **Create Subproject**
100+
101+
Method: POST
102+
103+
:::image type="content" source="media/tutorial-seismic-ddms/postman-api-create-subproject.png" alt-text="Screenshot that shows the API that creates a subproject." lightbox="media/tutorial-seismic-ddms/postman-api-create-subproject.png":::
104+
105+
### Dataset
106+
107+
Register a dataset in your Azure Data Manager for Energy instance.
108+
109+
API: **Dataset** > **Register a Dataset**
110+
111+
Method: POST
112+
113+
:::image type="content" source="media/tutorial-seismic-ddms/postman-api-create-dataset.png" alt-text="Screenshot that shows the API that creates a dataset." lightbox="media/tutorial-seismic-ddms/postman-api-create-dataset.png":::
114+
115+
### Applications
116+
117+
Register applications in your Azure Data Manager for Energy instance.
118+
119+
API: **Application** > **Register a New Application**
120+
121+
Method: POST
122+
123+
:::image type="content" source="media/tutorial-seismic-ddms/postman-api-register-application.png" alt-text="Screenshot that shows the API that registers an application." lightbox="media/tutorial-seismic-ddms/postman-api-register-application.png":::
63124

64125
## Next steps
126+
127+
As an alternative user experience to Postman, you can use SDUTIL to directly interact with the seismic store via the command line Python utility tool. Please follow this tutorial to get started.
128+
65129
<!-- Add a context sentence for the following links -->
66130
> [!div class="nextstepaction"]
67131
> [Seismic DDMS SDUTIL tutorial](./tutorial-seismic-ddms-sdutil.md)

0 commit comments

Comments
 (0)