2020-10-14 16:56:25 -07:00
|
|
|
---
|
|
|
|
id: az
|
|
|
|
title: Azure Subscription
|
|
|
|
sidebar_label: Azure
|
|
|
|
---
|
|
|
|
|
|
|
|
## What
|
|
|
|
|
|
|
|
Display the currently active Azure subscription information.
|
|
|
|
|
|
|
|
## Sample Configuration
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"type": "az",
|
|
|
|
"style": "powerline",
|
2022-02-02 10:38:31 -08:00
|
|
|
"powerline_symbol": "\uE0B0",
|
2020-10-14 16:56:25 -07:00
|
|
|
"foreground": "#000000",
|
|
|
|
"background": "#9ec3f0",
|
2022-03-27 01:12:47 -07:00
|
|
|
"template": " \uFD03 {{ .EnvironmentName }}"
|
2020-10-14 16:56:25 -07:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2022-03-09 04:46:57 -08:00
|
|
|
## Properties
|
|
|
|
|
|
|
|
- source: `string` - where to fetch the information from - defaults to `first_match`
|
|
|
|
- `first_match`: try the CLI config first, then the PowerShell module. The first to resolve is displayed
|
|
|
|
- `cli`: fetch the information from the CLI config
|
|
|
|
- `pwsh`: fetch the information from the PowerShell Module config
|
|
|
|
|
2022-02-01 03:10:46 -08:00
|
|
|
## Template ([info][templates])
|
|
|
|
|
|
|
|
:::note default template
|
|
|
|
|
|
|
|
``` template
|
|
|
|
{{ .Name }}
|
|
|
|
```
|
|
|
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
### Properties
|
2021-09-18 02:30:52 -07:00
|
|
|
|
2022-03-21 08:05:23 -07:00
|
|
|
- `.EnvironmentName`: `string` - account environment name
|
|
|
|
- `.HomeTenantID`: `string` - home tenant id
|
|
|
|
- `.ID`: `string` - account/subscription id
|
2021-09-18 02:30:52 -07:00
|
|
|
- `.IsDefault`: `boolean` - is the default account or not
|
2022-03-21 08:05:23 -07:00
|
|
|
- `.Name`: `string` - account name
|
|
|
|
- `.State`: `string` - account state
|
|
|
|
- `.TenantID`: `string` - tenant id
|
|
|
|
- `.User.Name`: `string` - user name
|
|
|
|
- `.User.Type`: `string` - user type
|
2022-01-13 23:46:02 -08:00
|
|
|
- `.Origin`: `string` - where we received the information from, can be `CLI` or `PWSH`
|
2021-09-18 02:30:52 -07:00
|
|
|
|
2022-04-20 09:43:59 -07:00
|
|
|
[templates]: /docs/configuration/templates
|