Back to Oh My Posh

Azure Functions

website/docs/segments/cloud/azfunc.mdx

29.12.04.8 KB
Original Source

What

Display the currently active Azure Functions CLI version.

Sample Configuration

import Config from "@site/src/components/Config.js";

<Config data={{ type: "azfunc", style: "powerline", powerline_symbol: "\uE0B0", foreground: "#ffffff", background: "#FEAC19", template: " \uf0e7 {{ .Full }} ", options: { fetch_version: true, display_mode: "files", }, }} />

Options

NameTypeDefaultDescription
home_enabledbooleanfalsedisplay the segment in the HOME folder or not
fetch_versionbooleantruefetch the Azure Functions CLI version
cache_durationstringnonethe duration for which the version will be cached. The duration is a string in the format 1h2m3s and is parsed using the time.ParseDuration function from the Go standard library. To disable the cache, use none
missing_command_textstringtext to display when the command is missing
display_modestringcontext<ul><li>always: the segment is always displayed</li><li>files: the segment is only displayed when file extensions listed are present</li><li>context: displays the segment when the environment or files is active</li></ul>
version_url_templatestringa go text/template template that creates the URL of the version info / release notes
extensions[]stringhost.json, local.settings.json, function.jsonallows to override the default list of file extensions to validate
folders[]stringallows to override the list of folder names to validate
tooling[]stringfuncthe tooling to use for fetching the version

Template (info)

:::note default template

template
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}

:::

Properties

NameTypeDescription
.Fullstringthe full version
.Majorstringmajor number
.Minorstringminor number
.Patchstringpatch number
.Errorstringerror encountered when fetching the version string