Merge pull request #310922 from bharathim/eds-release

Update Quick start with external data services changes

Author: Carolyn135

articles/energy-data-services/.openpublishing.redirection.energy-data-services.json

@@ -1,14 +1,24 @@
 {
     "redirections": [
         {
-            "source_path": "how-to-generate-refresh-token.md",
-            "redirect_url": "how-to-generate-auth-token.md",
+            "source_path_from_root": "/articles/energy-data-services/how-to-generate-refresh-token.md",
+            "redirect_url": "/azure/energy-data-services/how-to-generate-auth-token",
             "redirect_document_id": false
         },
         {
             "source_path_from_root": "/articles/energy-data-services/reliability-energy-data-services.md",
             "redirect_url": "/azure/reliability/reliability-energy-data-services",
             "redirect_document_id": false
+        },
+        {
+            "source_path_from_root": "/articles/energy-data-services/how-to-enable-external-data-sources.md",
+            "redirect_url": "/azure/energy-data-services/how-to-enable-external-data-services",
+            "redirect_document_id": false
+        },
+        {
+            "source_path_from_root": "/articles/energy-data-services/how-to-register-external-data-sources.md",
+            "redirect_url": "/azure/energy-data-services/how-to-register-external-data-services",
+            "redirect_document_id": false
         }
     ]
 }

articles/energy-data-services/faq-energy-data-services.yml

@@ -30,7 +30,7 @@ sections:
           answer: >
             The OSDU® platform does not offer APIs for making country/region specific configuration changes. These configuration settings are stored in .json files within the legal service container, and any changes require a service restart to take effect. Additionally, the Azure Data Manager for Energy service architecture does not expose the underlying infrastructure to customers, preventing them from making these changes directly.
 
-    - name: External Data Sources
+    - name: External Data Services 
       questions:
         - question:  What is the impact of data sharing across tenancy boundaries on security, privacy, and compliance?
           answer: >

articles/energy-data-services/how-to-enable-external-data-services.md

@@ -0,0 +1,92 @@
+---
+title: Enable External Data Services in Azure Data Manager for Energy
+description: Learn how to enable External Data Services (EDS) to pull metadata from OSDU-compliant external data sources into Azure Data Manager for Energy.
+author: bharathim
+ms.author: bselvaraj
+ms.service: azure-data-manager-energy
+ms.topic: how-to
+ms.date: 03/05/2025
+ms.custom: template-how-to
+---
+
+# Enable External Data Services (EDS) in Azure Data Manager for Energy
+
+This article describes how to enable External Data Services (EDS) in Azure Data Manager for Energy. EDS allows you to pull metadata from OSDU-compliant external data sources into Azure Data Manager for Energy. 
+
+Azure resources can use a [managed identity](/entra/identity/managed-identities-azure-resources/overview) to authenticate to other services without storing credentials in code. Use either a system-assigned or user-assigned managed identity to enable the EDS secret service to access secrets stored in your Azure Key Vault.
+
+## Prerequisites
+
+- An active Azure subscription. [Create a subscription for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
+- An Azure Data Manager for Energy resource. [Create an Azure Data Manager for Energy instance](quickstart-create-microsoft-energy-data-services-instance.md).
+
+## Create or configure a Key Vault
+
+Use an Azure Key Vault to store secrets managed by the secret service.
+
+1. Create a new Key Vault or use an existing one. To learn how to create a Key Vault, see [Quickstart: Create a key vault using the Azure portal](/azure/key-vault/general/quick-create-portal).
+
+   > [!IMPORTANT]
+   > Your Key Vault must exist in the same tenant as your Azure Data Manager for Energy resource. When you create the Key Vault, select [Enable purge protection (enforce a mandatory retention period for deleted vaults and vault objects)](/azure/key-vault/general/key-vault-recovery?tabs=azure-portal#what-are-soft-delete-and-purge-protection).
+
+1. In the **Access configuration** tab, under **Permission model**, select **Azure role-based access control (recommended)**.
+   :::image type="content" source="media/how-to-enable-external-data-services/create-a-key-vault.jpg" lightbox="media/how-to-enable-external-data-services/create-a-key-vault.jpg" alt-text="Screenshot showing the Access configuration tab with Permission model set to Azure role-based access control.":::
+
+1. Select **Review + create** to create the key vault.
+
+## Grant user-assigned managed identity permissions to the Key Vault
+
+Use the following steps to grant a user-assigned managed identity with permissions to the Key Vault.
+
+1. In the Azure portal, go to your Key Vault.
+1. Select **Access control (IAM)** from the left menu and select **+ Add** > **Add role assignment**.
+   :::image type="content" source="media/how-to-enable-external-data-services/key-vault-add-role-assignment.png" alt-text="Screenshot of adding role assignment to key vault." lightbox="media/how-to-enable-external-data-services/key-vault-add-role-assignment.png":::
+
+1. On the **Role** tab, select **Job function roles**, search for and select **Key Vault Secrets User**, and then select **Next**.
+   :::image type="content" source="media/how-to-enable-external-data-services/key-vault-secrets-user-selection.png" alt-text="Screenshot of selecting Key Vault Secrets User role." lightbox="media/how-to-enable-external-data-services/key-vault-secrets-user-selection.png":::
+
+   > [!NOTE]
+   > Use **Key Vault Secrets Officer** role when you want to allow the managed identity to manage secrets in addition to reading them.
+    
+1. On the **Members** tab, select **Managed identity** for **Assign access to**.
+1. Select **+ Select members**.
+1. Select **User-assigned managed identity** on the **Managed identity** dropdown.
+1. Select the user-assigned managed identity, and select **Select**.
+   :::image type="content" source="media/how-to-enable-external-data-services/select-a-user-assigned-managed-identity.png" alt-text="Screenshot of selecting a user-assigned managed identity." lightbox="media/how-to-enable-external-data-services/select-a-user-assigned-managed-identity.png":::
+
+1. Select **Review + assign** to complete the role assignment.
+   :::image type="content" source="media/how-to-enable-external-data-services/key-vault-review-and-assign.png" alt-text="Screenshot of review and assign of role assignment to key vault." lightbox="media/how-to-enable-external-data-services/key-vault-review-and-assign.png":::
+
+## Grant system-assigned managed identity permissions to the Key Vault
+
+Use the following steps if you're using a system-assigned managed identity instead.
+
+1. In the Azure portal, go to your Key Vault.
+1. Select **Access control (IAM)** from the left menu.
+1. Select **+ Add** > **Add role assignment**.
+1. On the **Role** tab, select **Job function roles**, search for and select **Key Vault Secrets User**, and then select **Next**.
+1. On the **Members** tab, select **User, group, or service principal** for **Assign access to**.
+1. Select **+ Select members**.
+1. Search for your Azure Data Manager for Energy instance, select it, and select **Select**.
+   :::image type="content" source="media/how-to-enable-external-data-services/select-a-system-assigned-managed-identity.png" alt-text="Screenshot of selecting a system-assigned managed identity." lightbox="media/how-to-enable-external-data-services/select-a-system-assigned-managed-identity.png":::
+1. Select **Review + assign** to complete the role assignment.
+
+## Enable External Data Services in Azure Data Manager for Energy
+
+Use the following steps to enable External Data Services in your Azure Data Manager for Energy resource.
+
+1. Go to your Azure Data Manager for Energy resource in the Azure portal.
+1. In the left menu, under **Advanced**, select **External Data Services**.
+1. Select the checkbox to **Enable External Data Services**.
+1. Select **Select a Key Vault** to open the form. Select the subscription and the Key Vault you created earlier, and then select **Add**.
+   :::image type="content" source="media/how-to-enable-external-data-services/external-data-services-select-a-key-vault.png" alt-text="Screenshot of selecting a Key Vault for External Data Services." lightbox="media/how-to-enable-external-data-services/external-data-services-select-a-key-vault.png":::
+1. Under **Managed identity type**, select **User-assigned managed identity** or **System-assigned managed identity**.
+1. If you select **User-assigned managed identity**, select **Select user assigned managed identity** to open the form. Select the subscription and managed identity, and then select **Add**.
+   :::image type="content" source="media/how-to-enable-external-data-services/external-data-services-select-a-user-assigned-managed-identity.png" alt-text="Screenshot of selecting a user-assigned managed identity for External Data Services." lightbox="media/how-to-enable-external-data-services/external-data-services-select-a-user-assigned-managed-identity.png":::
+1. Select **Save** to apply the configuration.
+   :::image type="content" source="media/how-to-enable-external-data-services/external-data-services-save-configuration.png" alt-text="Screenshot of saving the External Data Services configuration." lightbox="media/how-to-enable-external-data-services/external-data-services-save-configuration.png":::
+
+## Next steps
+
+- [How to register an external data services with Azure Data Manager for Energy?](how-to-register-external-data-services.md)
+- [External data services FAQ](faq-energy-data-services.yml#external-data-services)

articles/energy-data-services/how-to-enable-external-data-sources.md

@@ -1,60 +1,49 @@
 ---
-title: "Microsoft Azure Data Manager for Energy - How to register external data sources"
+title: "Microsoft Azure Data Manager for Energy - How to register external data services"
 description: "This article describes how to register external data sources with Azure Data Manager for Energy."
 author: bharathim
 ms.author: bselvaraj
 ms.service: azure-data-manager-energy
 ms.topic: how-to #Don't change
-ms.date: 03/14/2024
+ms.date: 02/02/2026
 
 #customer intent: As a Data Manager in Operating company, I want to register external data sources with Azure Data Manager for Energy so that I could pull metadata at scheduled intervals and retrieve bulk data on demand.
 
 ---
-# How to register an External Data Sources (EDS) with Azure Data Manager for Energy?
-This article explains how to register an External Data Sources (EDS) with Azure Data Manager for energy. EDS allows you to fetch and ingest data (metadata) from external data sources. It also allows you to retrieve bulk data on demand.
+# Register an External Data Services (EDS) with Azure Data Manager for Energy
+This article explains how to register an External Data Services (EDS) with Azure Data Manager for energy. EDS allows you to fetch and ingest data (metadata) from external data sources. It also allows you to retrieve bulk data on demand.
 
 ## Prerequisites 
-- Download and import API [collection](https://community.opengroup.org/osdu/pre-shipping/-/blob/main/R3-M23/QA_Artifacts_M23/EDS/EDS_Ingest_M23_Pre-Shipping_Setup_and_Testing.postman_collection.json?ref_type=heads) and [environment](https://community.opengroup.org/osdu/pre-shipping/-/blob/main/R3-M23/QA_Artifacts_M23/envFilesAndCollections/envFiles/OSDU%20R3%20M23%20Azure%20pre-ship.postman_environment.json?ref_type=heads) files into API test client. Make appropriate modifications in environment based on your data source. 
+- Download and import [API Postman collection for EDS](https://community.opengroup.org/osdu/pre-shipping/-/tree/main/R3-M25/QA_Artifacts_M25/EDS?ref_type=heads).
 - Refer **Section 2.2** in [osdu-eds-data-supplier-enablement-guide](https://gitlab.opengroup.org/osdu/r3-program-activities/docs/-/raw/master/R3%20Document%20Snapshot/23-osdu-eds-data-supplier-enablement-guide.pdf) for details on Data source Registration. 
 - Review **Connected Source Registry Entry (CSRE)** and **Connection Source Data Job (CSDJ)** sections in [EDS_Documentation-1.0.docx](https://gitlab.opengroup.org/osdu/subcommittees/ea/projects/extern-data/docs/-/blob/master/Design%20Documents/Training/EDS_Documentation-1.0.docx) to understand the various parameters used in data source registration. 
+- Additionally, review the [EDS configuration guide](https://osdu.pages.opengroup.org/platform/data-flow/ingestion/osdu-airflow-lib/eds-configuration-guide/) for more details on EDS configuration parameters.
 - To run EDS, the user must be a member of `service.eds.user` entitlements group. Additionally, to access Secret service, the user should be a member of the following entitlements: `service.secret.viewer`, `service.secret.editor`, `service.secret.admin`.  
 
-## EDS Fetch and Ingest workflow 
+## Run the EDS Fetch and Ingest workflow
 Execute the APIs in the following collections to register your external data source that runs EDS Fetch and Ingest workflow on a schedule: 
 
 1. `001: Pre-req: Validate Schema Registration`
 1. `002: Pre-req: Validate Reference Data` 
 1. `003: Secret Service` 
-1. `004: Pre-req: Add Source Registry` 
+1. `004: Add Source Registry and Data Job` 
 
-After successful data registration, data is regularly fetched from external sources and added to your Azure Data Manager for Energy. 
+After successful data registration, data is regularly fetched from external sources and added to your Azure Data Manager for Energy. You can use the Search service to search for your ingested data. 
 
-You can use the Search service to search for your ingested data. 
+## Troubleshooting issues
 
-## Troubleshooting
+Run the following Kusto queries in your Log Analytics workspace to identify any issues with data source registration. 
 
-You could run the below Kusto queries in your Log analytics workspace to identify any issues with Data Source registration. 
-
-
-```kusto
-OEPAirFlowTask 
-| where DagName == "eds_ingest"        
-| where LogLevel == "ERROR" // ERROR/DEBUG/INFO/WARNING
-```
 
 ```kusto
 OEPAirFlowTask 
-| where DagName == "eds_scheduler"        
+| where DagName == "eds_ingest" or DagName == "eds_scheduler"        
 | where LogLevel == "ERROR" // ERROR/DEBUG/INFO/WARNING
 ```
 ## Retrieve bulk data on demand
 Use **getRetrievalInstructions** API in `005: Dataset Service collection` to retrieve bulk data from external data sources on demand. 
 
 ## References
-* [External data sources FAQ](faq-energy-data-services.yml#external-data-sources)
+* [External data services FAQ](faq-energy-data-services.yml#external-data-services)
 * [EDS documentation 1.0](https://gitlab.opengroup.org/osdu/subcommittees/ea/projects/extern-data/docs/-/blob/master/Design%20Documents/Training/EDS_Documentation-1.0.docx)
-* [OSDU EDS Documentation](https://osdu.pages.opengroup.org/platform/data-flow/ingestion/osdu-airflow-lib/)
-* [EDS M23 release notes](https://community.opengroup.org/osdu/governance/project-management-committee/-/wikis/M23-Release-Notes)
-* [EDS API collection](https://community.opengroup.org/osdu/pre-shipping/-/blob/main/R3-M23/QA_Artifacts_M23/EDS/EDS_Ingest_M23_Pre-Shipping_Setup_and_Testing.postman_collection.json?ref_type=heads)
-* [EDS supplier enablement guide](https://gitlab.opengroup.org/osdu/r3-program-activities/docs/-/raw/master/R3%20Document%20Snapshot/23-osdu-eds-data-supplier-enablement-guide.pdf)
-* [EDS issues](https://community.opengroup.org/osdu/platform/data-flow/ingestion/external-data-sources/core-external-data-workflow/-/issues)
+* [OSDU EDS Documentation](https://osdu.pages.opengroup.org/platform/data-flow/ingestion/osdu-airflow-lib/)