https://github.com/martinpankraz/azcosmosdb-odata-shim
Project to connect consumers like SAP Business Technology Platform apps/services via OData with Azure PaaS
https://github.com/martinpankraz/azcosmosdb-odata-shim
app-service azure azure-blob-storage cosmosdb distributed-systems dotnet front-door odata sap sap-btp-cloud-foundry
Last synced: 2 months ago
JSON representation
Project to connect consumers like SAP Business Technology Platform apps/services via OData with Azure PaaS
- Host: GitHub
- URL: https://github.com/martinpankraz/azcosmosdb-odata-shim
- Owner: MartinPankraz
- License: apache-2.0
- Created: 2021-05-06T10:25:47.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-17T23:38:36.000Z (almost 2 years ago)
- Last Synced: 2025-03-20T23:05:37.613Z (2 months ago)
- Topics: app-service, azure, azure-blob-storage, cosmosdb, distributed-systems, dotnet, front-door, odata, sap, sap-btp-cloud-foundry
- Language: HTML
- Homepage:
- Size: 2.52 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Azure PaaS OData Proxy
[](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=364871140)
Dotnet6 project to connect consumers like apps/services hosted on **SAP Business Technology Platform** via OData with Azure PaaS services through their native SDKs. This repos uses [Azure CosmosDB](https://learn.microsoft.com/azure/cosmos-db/introduction) and its NoSQL API SDK as well as provides foundation for Azure Blob Storage.
Apply the app to enable scenarios like below: for scalable global read-access to selected SAP data and SAP Private Link scenarios for SAP Cloud Application Programming Model (CAP).
1. [Geodes pattern](https://docs.microsoft.com/azure/architecture/patterns/geodes) for BTP apps powered by Azure CosmosDB. Learn more about the setup [here](documentation/GEODES-GUIDE.md) and checkout the corresponding [blog post](https://blogs.sap.com/2021/06/11/sap-where-can-i-get-toilet-paper-an-implementation-of-the-geodes-pattern-with-s4-btp-and-azure-cosmosdb/)
2. [OData proxy pattern with private connectivity for SAP CAP apps](https://blogs.sap.com/2023/04/24/sap-private-linky-swear-with-azure-enabling-sap-cap-with-azure-services-without-odata-apis-using-sap-private-link/) powered by Azure CosmosDB (serverless). Find the CAP app repos [here](https://github.com/MartinPankraz/sap-cap-cosmos-app).
> **Note** - Learn more about private connectivity for SAP NodeJS apps powered by distributed Azure CosmosDB NoSQL [here](https://blogs.sap.com/2023/01/27/sap-private-linky-swear-with-azure-global-scale-with-azure-cosmos-db-with-sap-private-link/).
> **Note** - the OData proxy is configured to be compatible with any Azure PaaS services. Foundation for [Azure Blob storage](GenericODataWebAPI.Blob/AzureBlobRepository.cs) is already present.
## Getting Started 🛫
### Prerequisites to replicate the blue print
Our implementation creates a fully functional solution. The approach is standardized, so that all components could be replaced as long as the runtime environment for the application stays .NET 6. To replicate our particular setup you will need:
- [Azure account with subscription](https://azure.microsoft.com/free/) and rights to deploy Azure CosmosDB and App Service in two regions
- SAP on Azure with private VNet connectivity or routing from private VNet to SAP any-premise
- [SAP BTP account](https://cockpit.eu20.hana.ondemand.com/cockpit) with Business Application Studio, Destination configured and Fiori Launchpad service to host an HTML5 app
- (optional) Azure AD authorization to configure app registration and potentially give admin consent initially
- (optional) Access to SE80 on SAP backend to upload [Z-Programm](ZDemoFrontDoorReport.abap) for data extraction HTTP Post via ABAP.
### Quickstart 🚀
Move [appsettings.json](Templates/appsettings.json) template to [root of GenericODataWebAPI](GenericODataWebAPI/) and maintain according to your environment. The 'appsettings.json' is ignored by git, so you can safely maintain your secrets in the file.
```bash
cd GenericODataWebAPI
dotnet run
```
- Navigate to [https://localhost:52055/health](https://localhost:52055/health) to check if the app is running.
- Use [provided queries](sample-http-requests/sflight-requests.http) to test further with [VS Code REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client). Alternatively, find the Postman collection in the [Templates folder](Templates/Cosmos-OData-Shim.postman_collection.json).
> **Note** - From within GitHub Codespaces, click the URL shown (https://localhost:52055) on the console output to navigate to the exposed domain and port. It will be something like https://.preview.app.github.dev/health
Public interfaces are:
- /health
- /api/geode
- /api/odata/$metadata
Protected interfaces are:
- /api/odata/*
Consider [tweaking](https://docs.microsoft.com/odata/webapi/batch) the OData batch configuration on the [Startup.cs](GenericODataWebAPI/Startup.cs) depending on your requirements.
#### Config examples testing the OData API
Build upon [provided queries](sample-http-requests/sflight-requests.http) to test with [VS Code REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) for convenience.
Fill the details you collected from your app registration on AAD on the environment and pay attention to the difference between client_id and scope. They use the same id but have different prefix and suffix. We didn't provide fixed values for the prefix, because they can be altered by you during creation on Azure.
The **Tests** tab writes the env variable bearerToken, which is used for all calls in the collection, that require authentication.
## Deploy to Azure🪂
This repos offers two flavours of deployment guidance supporting the associated blog posts with the goal in mind to reduce time to reproduce. Not every step is template driven yet.
1. via template deployment, VS Code extension and some manual steps - more information is available [here](documentation/DEPLOYMENT-VSCODE.md)
2. (coming soon) via Azure Developer CLI
## What's next?
You can do a lot more once the app is deployed. Curious? We go you covered with some more information [here](documentation/WHATS-NEXT.md)
## Final words
Feel free to reach out over GitHub Issues in case of any questions :-) Until then happy integrating and enjoy reading your SAP data globally.