The supplychain-azure-function-dataset-download is a specialization for the Cosmo Tech Supply Chain solution of the the generic azure function app azure-function-scenario-download

This Supply Chain specific version is based on the Cosmotech Azure function Scenario Download

This azure function app aims to be integrated in the Cosmo Tech Supply Chain Web-app : azure-supplychain-webapp for Cosmo Tech internal use or azure-supplychain-webapp-shared for external use.

The azure function allows the web-app to get the data associated to a given scenario, including parameters and datasets of types :

• Azure Digital Twin
• Cosmo Tech Twin Cache
• Storage (lever files)

• Dedicated App registration created (see details below)

1. Create a new app registration
2. Add a API permission to the Cosmo Tech Platform API, choose the permission type Application (not Delegated) and select the permission Platform.Admin
3. Create a client secret
4. In the related Azure Digital Twins resources, assign the role Azure Digital Twin Data Reader to app registration
   
   

Check option Enable Access-Control-Allow-Credentials

• Add the URL of the Cosmo Tech Supply Chain Web-App
• For dev usage (optional) add http://localhost:3000

The azure function includes a first level of securizartion with the host key.
This keys being included in the web application, we need a second layer of securization by limiting the azure function calls to the users being authorized to the Cosmo Tech API

• Go to Authentication
• Add identity provider
• Select "Microsoft"
• In "App registration type", select "Pick an existing app registration in this directory"
• Name or app ID : enter the web application name.
  Note : You may need to enter the app registration ID created for the webapp instead of its name. And in this case, you will have to create a secret for the app registration of the web app and provide it here.

• Restrict access : "Require authentication"
• Unauthenticated requests : HTTP 401
• Token store : leave checked

• In the created identity provider, click on "Edit"
• Allowed token audiences : Enter the appplication ID URL of the platform app registration (of type "https://cosmo platform url" or "api://platform app registrion application id uri" )

export const AZURE_FUNCTION_FLOWCHART_URL =
  'https://<azure function deployment url>/api/ScenarioDownload';
export const AZURE_FUNCTION_FLOWCHART_HEADERS = {
  'x-functions-key': '<default host keys>',
};

Example with the demand plan table

  demand_plan: {
    connectorId: 'c-ll43p5nll5xqx',
    defaultFileTypeFilter: '.csv',
    subType: 'AZURETABLE',
    azureFunction: 'https://<azure function deployment url>/api/DemandsPlan',
    azureFunctionHeaders: { 'x-functions-key': '<default host keys>' },
  }

By default, the azure function app references the Cosmo-Tech Supply Chain generic PyPi package CosmoTech-SupplyChain from the requirements.txt file

In case, you need to use your own library version, you need to change this dependency by pointing to your own PyPi package or your specific git repository, like for exemple git+ssh://[email protected]/<your repo>/supplychain-python-library.git@main#egg=SupplyChain.

Note : in the azure function references in the requirements.txt file, you have to leave the dependency to the PyPi package CosmoTech-Acceleration-Library unchanged since this is one is generic.

The generic azure comes with an GitHub action allowing to automate its build and the generation of the artifact Artifact.zip. This automatic build is facilitated by the fact that the generic PyPi package is public.

When you change the library dependency to a private repository, you need to put in place credentials management to use your own repository. You may find easier to simply build the azure function locally (using your git credentials)

pip install --target .python_packages/lib/site-packages/ -r requirements.txt
zip -r artifact.zip . -x ".git/*" ".github/*" ".gitignore"

In order to deploy the new artifact, you have to make it accessible for deployment from the azure function app instance through an https URL.

• if the build can be automated, URL can point to a GitHub release (like the generic azure function)
  Example URL : https://github.com/Cosmo-Tech/supplychain-azure-function-dataset-download/releases/download/x.y.z/artifact.zip

• if not, the artifact zip file can be copied to an azure blob storage
  example URL : https://myblobstorage.blob.core.windows.net/content/artifact.zip?st=2018-02-13T09%3A48%3A00Z&se=2044-06-14T09%3A48%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=bNrVrEFzRHQB17GFJ7boEanetyJ9DGwBSV8OM3Mdh%2FM%3D

Then to deploy the new artifact version, go to the azure function app settings in the Azure portal.
Change the WEBSITE_RUN_FROM_PACKAGE parameter with the new artifact URL.

Or execute the following command from the Azure CLI

az webapp config appsettings set --name <function app name> --resource-group <resource group name> --settings WEBSITE_RUN_FROM_PACKAGE=<URL>

Note : The function app automatically restarts after a configuration change.