mirror of
https://github.com/JanDeDobbeleer/oh-my-posh.git
synced 2025-01-30 12:32:22 -08:00
54 lines
1.3 KiB
Plaintext
54 lines
1.3 KiB
Plaintext
---
|
|
id: az
|
|
title: Azure Subscription
|
|
sidebar_label: Azure
|
|
---
|
|
|
|
## What
|
|
|
|
Display the currently active Azure subscription information.
|
|
|
|
:::caution
|
|
PowerShell offers support for the `Az.Accounts` module, but it is disabled by default.
|
|
To enable this, set `$env:AZ_ENABLED = $true` in your `$PROFILE`.
|
|
:::
|
|
|
|
## Sample Configuration
|
|
|
|
```json
|
|
{
|
|
"type": "az",
|
|
"style": "powerline",
|
|
"powerline_symbol": "\uE0B0",
|
|
"foreground": "#000000",
|
|
"background": "#9ec3f0",
|
|
"properties": {
|
|
"template": "{{ .EnvironmentName }}",
|
|
"prefix": " \uFD03 "
|
|
}
|
|
}
|
|
```
|
|
|
|
## Properties
|
|
|
|
- template: `string` - A go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the
|
|
properties below - defaults to `{{.Name}}`
|
|
|
|
## Template Properties
|
|
|
|
:::caution
|
|
When using the PowerShell module, only `.EnvironmentName`, `.ID`, `.Name` and `.User.Name` are available.
|
|
:::
|
|
|
|
- `.EnvironmentName`: `string` - the account environment name
|
|
- `.HomeTenantID`: `string` - the home tenant id
|
|
- `.ID`: `string` - the account/subscription id
|
|
- `.IsDefault`: `boolean` - is the default account or not
|
|
- `.Name`: `string` - the account name
|
|
- `.State`: `string` - the account state
|
|
- `.TenantID`: `string` - the tenant id
|
|
- `.User.Name`: `string` - the user name
|
|
|
|
[go-text-template]: https://golang.org/pkg/text/template/
|
|
[sprig]: https://masterminds.github.io/sprig/
|