oh-my-posh/website/docs/segments/azfunc.mdx

64 lines
3.3 KiB
Plaintext
Raw Normal View History

2021-04-02 10:36:50 -07:00
---
id: azfunc
title: Azure Functions
sidebar_label: Azure Functions
2021-04-02 10:36:50 -07:00
---
## What
Display the currently active [Azure Functions CLI][az-func-core-tools] version.
2021-04-02 10:36:50 -07:00
## Sample Configuration
2024-01-13 02:11:22 -08:00
import Config from "@site/src/components/Config.js";
<Config
data={{
type: "azfunc",
style: "powerline",
powerline_symbol: "\uE0B0",
foreground: "#ffffff",
background: "#FEAC19",
template: " \uf0e7 {{ .Full }} ",
properties: {
fetch_version: true,
display_mode: "files",
},
}}
/>
2021-04-02 10:36:50 -07:00
## Properties
2024-01-13 02:11:22 -08:00
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the Azure Functions CLI version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when a `host.json` or `local.settings.json` files is present (**default**)</li></ul> |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
2024-01-21 05:14:26 -08:00
| `folders` | `[]string` | allows to override the list of folder names to validate |
2024-01-13 02:11:22 -08:00
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
2021-12-03 11:36:30 -08:00
2022-02-01 03:10:46 -08:00
## Template ([info][templates])
:::note default template
```template
2022-02-01 03:10:46 -08:00
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
```
:::
### Properties
2021-12-03 11:36:30 -08:00
| Name | Type | Description |
| -------- | -------- | -------------------------------------------------- |
| `.Full` | `string` | the full version |
| `.Major` | `string` | major number |
| `.Minor` | `string` | minor number |
| `.Patch` | `string` | patch number |
| `.Error` | `string` | error encountered when fetching the version string |
2021-12-03 11:36:30 -08:00
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates
[az-func-core-tools]: https://github.com/Azure/azure-functions-core-tools