Best practices to handle documentation in Azure - azure

Cloud-Platform: Azure
Resource: Logic Apps and Functions
Hi everyone,
Kontext:
We have developed many Logic Apps and Functions in our company so far. We do not use a proper or standard methodology to handle the documentation of the user requirements and also the required technical documentation of these logic apps and functions. For technical documentation I mean all the documentation generated during the development life-cycle.
We use also Jira to assign the logic apps inside the company and also we are using X-RAY for testing. We have also Confluence for documenting our guidelines to development.
Question:
I would like to know what are the best practices to handle the documentation and very important how to keep it up-to-date?.
Is there an functionality in Azure, Jira or Confluence that we can control easily the documentation of our logic Apps and functions?

It depends on the source code repository and the deployment pipeline that you are using to deploy the Azure functions and logic apps. If you are using GitHub or Azure DevOps, then you can make use of the GitHub/DevOps wiki to create documentation about logic apps or function projects just by creating readme files. Please review the following articles which will help you with the documentation
https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis
https://learn.microsoft.com/en-us/azure/devops/project/wiki/wiki-create-repo?view=azure-devops&tabs=browser

Related

Missing Logic Apps connector action from Logic Apps Standard Workflow when creating nested Logic apps

I created a Logic Apps Standard, a workflow, and a trigger of Request When a HTTP request is received, like below by following the link below:
https://learn.microsoft.com/en-us/azure/logic-apps/logic-apps-http-endpoint#create-a-callable-endpoint
However, I also want to create logic apps: Choose a Logic Apps workflow following the link below, but it is not available shown above.
https://learn.microsoft.com/en-us/azure/logic-apps/logic-apps-http-endpoint#create-nested-logic-apps
Image from the link above for comparison.
Questions
How to make it available under Logic Apps std or other versions apart from Consumption?
Why is it that many connectors that are available in Consumption are not available in the Standard plan?
Refs:
Why does Logic App Standard Plan have missing connection trigger?
I have tried to create an simple logic app in standard plan and unable to get this connector called Logic apps: Choose a Logic Apps workflow
And tried the same with consumption plan and its showing there .
So you can try with the same MS DOC that you are following with Logic app- Consumption
For more information please refer this MICROSOFT DOCUMENTATION: Single-tenant versus multi-tenant and integration service environment for Azure Logic Apps
Kindly note that we have something called managed connectors which are used in LA consumption and something called builtin connectors and can be used with standard logic apps.
The built in connectors are running in the LA standard process. While the managed are in a different process.
The list of actions which are available in managed connectors are not always available in the built in connectors.
Still you can use the managed connectors in the LA standard site.

Is it possible to define parameters through portal for Logic App (Standard)?

I have a single-tenant logic app and a workflow under it that needs a configurable input. In a multi-tenant logic app, one can define parameters through the azure portal and reference them in workflow definition (actions/ triggers). Is this not possible with a single-tenant logic app?
I am not able to find the answer in the documentation.
I know a deployment template should consult parameters file for this, however, I still have the above question specifically if I am doing stuff through the portal.
Edit 7/12
I am referring to the parameters concept explained here, and not the parameters tab of the triggers or actions. See below the parameters that we can define through the portal when working with the consumption logic app.
The answer is: not yet. Support for parameters in the designer (and therefore in the Azure Portal) is on its way, but not available yet.
In VS Code, you can create a parameters.json file.
But in the portal, there's no option (yet) to create/edit parameters.
Bec Lyons (Microsoft) demoed a version of the designer with this in it, although I can't remember if this was in the June Logic Apps Live session, or in the July Integration Down Under session.
In any case, the only currently supported way to do this is to create a parameters.json file and upload it.
You can either do this from VS Code or Azure CLI (using the preview logicapps CLI extension) OR you can FTP to your Logic App and upload it via an FTP client (e.g. FileZilla) - you can get the FTP login details by clicking the "Get Publish Profile" button in the overview of your Logic Apps Standard resource.
Once they release support for this in the Portal/Designer, I'll update this answer.
Also, worth noting that as of this date (July 2021), there are issues using parameters in Managed API Triggers - not sure yet if this is by design, or if it's a bug. Specifically the FileSystem, FTP and FTPWithSSH (SFTP) triggers.
Hope this helps. Probably not the answer you were looking for, though!

Guideline for Inter Service Communication with principal propagation with Cloud SDK on CF

We are trying to set two micro services where the principal needs to be propagated from the first microservice(Login happens here) to the second one (This uses cloud SDK to talk to S/4 Hana Cloud). Has this particular scenario been explored before / is there any existing guideline the Cloud SDK team suggests.
Anirban
The Cloud SDK capabilities related to Principal propagation in conjunction with OAuth flow are nicely explained in this blog article by Marco Dahms.
I hope you'll find an idea of how to adapt it to your use case. There are additional helpful links in the comments section of the blog.
If you give more details or what solutions you have already tried we are happy to help you further.
Cheers,
Artem

Difference between azure api-apps,logic-apps,web-apps and azure functions

What is the difference between azure API-apps,logic-apps,web-apps and azure functions? And what difference does it make for developer?
Logic Apps:
Logic Apps provide a way to simplify and implement scalable integrations and workflows in the cloud. It provides a visual designer to model and automate your process as a series of steps known as a workflow. There are many connectors across the cloud and on-premises to quickly integrate across services and protocols. A logic app begins with a trigger (like 'When an account is added to Dynamics CRM') and after firing can begin many combinations actions, conversions, and condition logic.
Api Apps:
API apps in Azure App Service offer features that make it easier to develop, host, and consume APIs in the cloud and on-premises. With API apps you get enterprise grade security, simple access control, hybrid connectivity, automatic SDK generation, and seamless integration with Logic Apps.
Web Apps:
App Service Web Apps is a fully managed compute platform that is optimized for hosting websites and web applications. This platform-as-a-service (PaaS) offering of Microsoft Azure lets you focus on your business logic while Azure takes care of the infrastructure to run and scale your apps.
Functions:
Azure Functions is a solution for easily running small pieces of code, or "functions," in the cloud. You can write just the code you need for the problem at hand, without worrying about a whole application or the infrastructure to run it. Functions can make development even more productive, and you can use your development language of choice, such as C#, F#, Node.js, Python or PHP. Pay only for the time your code runs and trust Azure to scale as needed. Azure Functions lets you develop serverless applications on Microsoft Azure.
Api apps and Web apps are pretty much the same deal. Logic Apps and Functions are the same in a sense that they allow you to do something as a response to event or on a schedule, but Functions are a way to run code (or existing app) and Logic Apps are more like a workflow constructor, where you take existing actions and chain them (so no coding, or almost no)
ps. You can easily find documentation for those online to get a broader understanding

Azure logic apps Deployment in Different Environment

I am using azure Standard service plan and developing Logic Apps Work flows. Now i want to deploy it to different environment like QA/UAT.
I have referred few MSDN blogs and found out We can do the logic apps deployment to different subscriptions via Visual studio with Azure SDK. However I am using API Apps in the logic apps work flows like SQL connector, Transformation service, BizTalk Xpath Extractor etc..
Can you please let me know how do we deploy API Apps to different Environment. Please suggest.
Thanks,
Vinoth
One way is to create the logic app with the connectors you want and then export that ARM template LogicApp -> Settings -> Export Template. Of course this template might not be the ideal approach since it will have lot of stuff hard coded specific to that LA.
The good approach will be to create a new Azure resource Group project which has
the logic app ARM template,
just copy the defn part from you existing logic apps int the template definition section
make sure you have the connection resources creation added as part of you template.
Some useful resources
1. Checkout this MSDN link.
2. There is a utility also to get the LA templates, read this

Resources