2021-04-02 10:36:50 -07:00
|
|
|
---
|
|
|
|
id: azfunc
|
|
|
|
title: Azure functions
|
|
|
|
sidebar_label: Azure functions
|
|
|
|
---
|
|
|
|
|
|
|
|
## What
|
|
|
|
|
|
|
|
Display the currently active Azure functions CLI version.
|
|
|
|
|
|
|
|
## Sample Configuration
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"type": "azfunc",
|
|
|
|
"style": "powerline",
|
2021-11-08 09:44:06 -08:00
|
|
|
"powerline_symbol": "\uE0B0",
|
2021-04-02 10:36:50 -07:00
|
|
|
"foreground": "#ffffff",
|
|
|
|
"background": "#FEAC19",
|
2022-03-27 01:12:47 -07:00
|
|
|
"template": " \uf0e7 {{ .Full }} ",
|
2021-04-02 10:36:50 -07:00
|
|
|
"properties": {
|
2022-01-22 10:46:56 -08:00
|
|
|
"fetch_version": true,
|
2021-04-02 10:36:50 -07:00
|
|
|
"display_mode": "files"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
2022-01-22 10:46:56 -08:00
|
|
|
- fetch_version: `boolean` - fetch the Azure functions CLI version - defaults to `true`
|
2021-04-02 10:36:50 -07:00
|
|
|
- display_error: `boolean` - show the error context when failing to retrieve the version information - defaults to `true`
|
|
|
|
- missing_command_text: `string` - text to display when the command is missing - defaults to empty
|
|
|
|
- display_mode: `string` - determines when the segment is displayed
|
|
|
|
- `always`: the segment is always displayed
|
|
|
|
- `files`: the segment is only displayed when a `host.json` or `local.settings.json` files is present (default)
|
2021-12-03 11:36:30 -08:00
|
|
|
|
2022-02-01 03:10:46 -08:00
|
|
|
## Template ([info][templates])
|
|
|
|
|
|
|
|
:::note default template
|
|
|
|
|
|
|
|
``` template
|
|
|
|
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
|
|
|
|
```
|
|
|
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
### Properties
|
2021-12-03 11:36:30 -08:00
|
|
|
|
|
|
|
- `.Full`: `string` - the full version
|
2021-12-04 01:32:50 -08:00
|
|
|
- `.Major`: `string` - major number
|
|
|
|
- `.Minor`: `string` - minor number
|
|
|
|
- `.Patch`: `string` - patch number
|
|
|
|
- `.Prerelease`: `string` - prerelease info text
|
|
|
|
- `.BuildMetadata`: `string` - build metadata
|
|
|
|
- `.Error`: `string` - when fetching the version string errors
|
2021-12-03 11:36:30 -08:00
|
|
|
|
2022-04-20 09:43:59 -07:00
|
|
|
[templates]: /docs/configuration/templates
|