Skip to content

docs: the Standard workflow.json shape and its three real differences - #43

Merged
craigthackerx merged 1 commit into
mainfrom
docs/standard-workflow-content
Aug 24, 2026
Merged

docs: the Standard workflow.json shape and its three real differences#43
craigthackerx merged 1 commit into
mainfrom
docs/standard-workflow-content

Conversation

@craigthackerx

Copy link
Copy Markdown
Contributor

The Logic App standard documented Consumption whole-definition authoring and the Standard app host, but never the Standard workflow artefact.

So it never said that on Standard a workflow is a file rather than an ARM resource, never showed the {definition, kind} wrapper, and never mentioned the connections.json authentication format.

What is added

  • The package layout, so it is obvious the workflow is a file in a zip alongside connections.json and host.json.
  • The workflow.json wrapper, with the point that matters most for reuse: the definition block is identical to a Consumption definition, so every WDL rule in the document applies unchanged and the annotated schema validates both.
  • kind is Stateful unless you have measured that 5 minutes is enough, cross-referenced to the hosting model section.
  • Three differences that are not cosmetic: the definition is a file not a resource, parameter values come from app settings via @appsetting() rather than the ARM body, and connections are V2 requiring access policies rather than V1 rejecting them.
  • The connections.json trap. VS Code writes managed API connections with a Raw scheme and an appsetting key; Azure expects ManagedServiceIdentity. Shipping the local shape unchanged is the most common Standard deployment failure and the error does not say so.

Why in the doc rather than the agent

azure-logic-app-standards.txt is a knowledge pack for logic-app-author, so documenting this here teaches the agent for free at the next just update-knowledge. The agent has 73 characters of headroom against its warning line, so this could not have gone into its instructions, and it should not have: the workflow.json shape is a fact, and facts belong in knowledge.

Verification

No broken anchors in the built output, the new section id resolves, npm run build clean, no em or en dashes.

The Logic App standard documented Consumption whole-definition authoring
and the Standard app HOST, but never the Standard workflow ARTEFACT. So
it never said that a Standard workflow is a file rather than an ARM
resource, never showed the {definition, kind} wrapper, and never
mentioned the connections.json authentication format.

Adds all three, plus the point that matters most for reuse: the
definition block inside a Standard workflow.json is identical to a
Consumption definition, so every WDL rule in the document applies
unchanged and the annotated schema validates both.

Also records the failure that produces an unhelpful error: Visual Studio
Code writes managed API connections with a Raw scheme and an appsetting
key, Azure expects ManagedServiceIdentity, and shipping the local shape
unchanged is the most common Standard deployment failure.
@github-actions

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@craigthackerx
craigthackerx merged commit ff4a58e into main Aug 24, 2026
7 checks passed
@craigthackerx
craigthackerx deleted the docs/standard-workflow-content branch August 24, 2026 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant