mirror of
https://github.com/JanDeDobbeleer/oh-my-posh.git
synced 2024-09-20 21:47:31 -07:00
63 lines
2.8 KiB
Plaintext
63 lines
2.8 KiB
Plaintext
---
|
|
id: az
|
|
title: Azure Subscription
|
|
sidebar_label: Azure
|
|
---
|
|
|
|
## What
|
|
|
|
Display the currently active Azure subscription information.
|
|
|
|
:::tip
|
|
PowerShell offers support for the [az][az] module, but it is disabled by default.
|
|
To enable this, set `$env:POSH_AZURE_ENABLED = $true` in your `$PROFILE` after
|
|
initializing Oh My Posh.
|
|
:::
|
|
|
|
## Sample Configuration
|
|
|
|
```json
|
|
{
|
|
"type": "az",
|
|
"style": "powerline",
|
|
"powerline_symbol": "\uE0B0",
|
|
"foreground": "#000000",
|
|
"background": "#9ec3f0",
|
|
"template": " \uFD03 {{ .EnvironmentName }}"
|
|
}
|
|
```
|
|
|
|
## Properties
|
|
|
|
| Name | Type | Description |
|
|
| -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `source` | `string` | <ul><li>`first_match`: try the CLI config first, then the PowerShell module. The first to resolve is displayed (**default**)</li><li>`cli`: fetch the information from the CLI config</li><li>`pwsh`: fetch the information from the PowerShell Module config</li></ul> |
|
|
|
|
## Template ([info][templates])
|
|
|
|
:::note default template
|
|
|
|
```template
|
|
{{ .Name }}
|
|
```
|
|
|
|
:::
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Description |
|
|
| ------------------ | --------- | -------------------------------------------------------------- |
|
|
| `.EnvironmentName` | `string` | Azure environment name |
|
|
| `.HomeTenantID` | `string` | home tenant id |
|
|
| `.ID` | `string` | subscription id |
|
|
| `.IsDefault` | `boolean` | is the default subscription or not |
|
|
| `.Name` | `string` | subscription name |
|
|
| `.State` | `string` | subscription state |
|
|
| `.TenantID` | `string` | tenant id |
|
|
| `.User.Name` | `string` | user name |
|
|
| `.User.Type` | `string` | user type |
|
|
| `.Origin` | `string` | where we received the information from, can be `CLI` or `PWSH` |
|
|
|
|
[templates]: /docs/configuration/templates
|
|
[az]: https://www.powershellgallery.com/packages/Az
|