Skip to content

Commit c9bec41

Browse files
mikefrobbinsmikefrobbins
authored
Refreshed, reflowed, converted to link refs (#5404)
1 parent b2c7a1b commit c9bec41

File tree

1 file changed

+89
-48
lines changed

1 file changed

+89
-48
lines changed

‎docs-ref-conceptual/Latest-version/reference-types-and-status.md

Lines changed: 89 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,140 @@
11
---
2-
title: Reference types, status and support levels – Azure CLI | Microsoft Docs
2+
title: Overview - Azure CLI terminology and support levels
33
description: Learn about the Azure CLI reference types, statuses and support levels
4-
ms.date: 03/24/2025
54
ms.service: azure-cli
65
ms.custom: devx-track-azurecli
76
keywords: azure cli references, reference types, reference status
87
---
98

109
# Overview: Azure CLI terminology and support levels
1110

12-
This article explains Azure CLI terminologies. There are syntax components, reference types, and statuses.
11+
This article explains Azure CLI terminologies. There are syntax components, reference types, and
12+
statuses.
1313

1414
## Azure CLI syntax components
1515

16-
The Azure CLI syntax is a combination of groups, references, commands, and parameters. Often the **full reference command** is referred to as **command**.
16+
The Azure CLI syntax is a combination of groups, references, commands, and parameters. Often, the
17+
complete reference command is referred to as a command.
1718

18-
| Azure Service | Reference group | Reference subgroup(s) | Command | Full reference command | Parameter Examples
19-
|-|-|-|-|-|-|
20-
| Azure CLI | [az config](../../docs-ref-autogen/Latest-version/latest/config.yml) | | | az config | --local, --output -o
21-
| Azure Network | [az network](../../docs-ref-autogen/Latest-version/latest/network.yml) | application-gateway | create | [az network application-gateway create](/cli/azure/network/application-gateway#az-network-application-gateway-create) | --name, --resource-group, --capacity
22-
| Azure DevOps | [az pipelines](../../docs-ref-autogen/Latest-version/latest/pipelines.yml) | agent | list | [az pipelines agent list](../../docs-ref-autogen/Latest-version/latest/pipelines/agent.yml) | --pool-id, --agent-name, --demands
19+
| Azure Service | Reference group | Reference subgroup | Command | Full reference command | Parameter Examples |
20+
| ------------- | ------------------ | ------------------- | ------- | --------------------------------------------- | ------------------------------------------ |
21+
| Azure CLI | [az config][01] | | | `az config` | `--local`, `--output`, `-o` |
22+
| Azure Network | [az network][02] | application-gateway | create | [`az network application-gateway create`][09] | `--name`, `--resource-group`, `--capacity` |
23+
| Azure DevOps | [az pipelines][03] | agent | list | [`az pipelines agent list`][04] | `--pool-id`, `--agent-name`, `--demands` |
2324

24-
A **reference subgroup** can have multiple levels such as `az network application-gateway private-link ip-config add`
25+
A reference subgroup can have multiple levels, such as
26+
`az network application-gateway private-link ip-config add`.
2527

26-
| Reference Group | Subgroup 1 | Subgroup 2 | Subgroup 3| Command|
27-
|-|-|-|-|-|
28-
|network|application-gateway|private-link|ip-config|add
28+
| Reference Group | Subgroup 1 | Subgroup 2 | Subgroup 3 | Command |
29+
| --------------- | ------------------- | ------------ | ---------- | ------- |
30+
| network | application-gateway | private-link | ip-config | add |
2931

30-
See [Reference list A to Z](../../docs-ref-autogen/Latest-version/latest/reference-index.yml) for a complete list of reference commands.
32+
See [Reference list A to Z][05] for a complete list of reference commands.
3133

3234
## What is reference type?
3335

34-
Azure CLI commands are either part of the **core** Azure CLI service, or they're an **extension**. Extensions are optional add-ons. The reference type determines the release schedule, status and installation method as described here:
36+
Azure CLI commands are either part of the core Azure CLI service or they're an extension. Extensions
37+
are optional add-ons. The reference type determines the release schedule, status, and installation
38+
method as described here:
3539

36-
| Term | Core | Extension |
37-
| - | - | -|
38-
| **References** | Are part of the primary Azure CLI service | Are optional reference commands that must be installed |
39-
| **Install** | Jointly with the [MSI installer](install-azure-cli-windows.md) | Individually with [az extension add](/cli/azure/extension#az-extension-add) |
40-
| **Released** | On a schedule | As new features or updates become available |
41-
| **Status** | Can be GA (Generally Available), preview or deprecated | Also can be GA, preview or deprecated |
40+
| Term | Core | Extension |
41+
| -------------- | ------------------------------------------------------ | ------------------------------------------------------ |
42+
| **References** | Are part of the primary Azure CLI service | Are optional reference commands that must be installed |
43+
| **Install** | Jointly with the [MSI installer][13] | Individually with [`az extension add`][07] |
44+
| **Released** | On a schedule | As new features or updates become available |
45+
| **Status** | Can be GA (Generally Available), preview or deprecated | Also can be GA, preview or deprecated |
4246

43-
To get a list of command groups, run `az`. For a list of extensions, use [az extension list-available --output table](/cli/azure/extension#az-extension-list-available) commands.
47+
To get a list of command groups, run `az`.
4448

4549
```azurecli-interactive
4650
# Get list of all command groups
4751
az
52+
```
53+
54+
For a list of extensions, use [`az extension list-available --output table`][08] commands.
4855

56+
```azurecli-interactive
4957
# Get list of extensions
5058
az extension list-available --output table
5159
```
5260

5361
### Core
5462

55-
Azure CLI references that have been published as a permanent part of the CLI are called **core references**. All core references install with the Azure CLI and you can't choose a subset of references. If you run the CLI through Azure Cloud Shell, core references are always up to date.
63+
Azure CLI references that are published as a permanent part of the Azure CLI are referred to as core
64+
references. All core references install with the Azure CLI, and you can't choose a subset of
65+
references. If you run the Azure CLI through Azure Cloud Shell, core references are always up to
66+
date.
5667

5768
### Extension
5869

59-
Extensions aren't shipped as part of the CLI but run as CLI commands. Some extensions are a permanent part of the Azure CLI, but often, an extension gives you access to preview and experimental commands. A single reference group, such as **az iot hub**, can have both core and extension commands. Here are two examples:
70+
Extensions aren't shipped as part of the Azure CLI but run as Azure CLI commands. Some extensions
71+
are a permanent part of the Azure CLI, but often, an extension gives you access to preview and
72+
experimental commands. A single reference group, such as `az iot hub`, can have both core and
73+
extension commands. Here are two examples:
6074

6175
| Full reference command | Is Core | Is Extension |
6276
| --------------------------------- | ------- | ------------ |
6377
| az iot hub list | yes | |
6478
| az iot hub job list | | yes |
6579

66-
You're prompted to install an extension upon first use. You can also install an extension by running the [az extension add](/cli/azure/extension#az-extension-add) command.
80+
You're prompted to install an extension upon first use. You can also install an extension by running
81+
the [az extension add][07] command.
6782

68-
You can learn more about extension references including installation and updating in [Use extensions with the Azure CLI](azure-cli-extensions-overview.md). See [Available extensions for the Azure CLI](azure-cli-extensions-list.md) for a complete list of extension reference commands.
83+
You can learn more about extension references including installation and updating in
84+
[Use extensions with the Azure CLI][11]. See [Available extensions for the Azure CLI][10] for a
85+
complete list of extension reference commands.
6986

7087
## What is reference status?
7188

72-
Regardless of reference type, Azure CLI references fall into three status categories: **GA** (Generally Available), **public preview** or **deprecated**. It's the reference command status (not type) that determines stability.
89+
Regardless of reference type, Azure CLI references fall into three status categories: **GA**
90+
(Generally Available), **public preview** or **deprecated**. It's the reference command status (not
91+
type) that determines stability.
7392

74-
| | GA | Public preview | Deprecated
75-
|-|-|-|-|
76-
| **Stability** | Permanent | Can change in response to customer feedback. Is subject to the terms of [Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). | Will be removed.
93+
| | GA | Public preview | Deprecated |
94+
| ------------- | --------- | ------------------------------------------------------------------------------------------------------- | ---------------- |
95+
| **Stability** | Permanent | Can change in response to customer feedback. Is subject to the terms of [Microsoft Azure Previews][12]. | Will be removed. |
7796

7897
> [!NOTE]
79-
> Warnings indicating **public preview** or **deprecated** are part of the Azure CLI command output and should be expected.
80-
81-
Most commands and parameters for a single reference have a single status, but not always. A GA reference that is being built out to offer more commands can have both GA and preview reference commands. As new parameters are added to increase functionality, a single command can also have parameters that fall under different status categories. Here are example references that have different statuses:
82-
83-
| Full reference command | Parameters | Type | GA | Public preview | Deprecated |
84-
| -------------------------- | -------------------------------------------------------------------- | --------- | --- | -------------- | ------------ |
85-
| az network dns zone list | All | Core | yes | | |
86-
| az network dns zone create | --name, --resource-group, --if-none-match, --parent-name | Core | yes | | |
87-
| | --existingParameter5 | Core | | | yes |
88-
| | --newParameter6 | Core | | yes | |
89-
| az network vhub list | All | Extension | yes | | |
90-
| az network vhub create | --address-prefix, --name, --resource-group, -vwan, --location, --sku | Extension | yes | | |
91-
| | --exsitingParameter7 | Extension | | yes | |
92-
| | --newParameter8 | Extension | yes | | |
93-
| az network firewall create | All | Extension | | yes | |
94-
95-
The above table is only an example and **isn't** representative of the current reference statuses for `az network`.
98+
> Warnings indicating **public preview** or **deprecated** are part of the Azure CLI command output
99+
> and should be expected.
100+
101+
Most commands and parameters for a single reference have a single status, but this isn't always the
102+
case. A GA reference that is being built out to offer more commands can include both GA and preview
103+
reference commands. As new parameters are added to increase functionality, a single command can also
104+
have parameters that fall under different status categories. Here are example references that have
105+
different statuses:
106+
107+
| Full reference command | Parameters | Type | GA | Public preview | Deprecated |
108+
| ---------------------------- | -------------------------------------------------------------------------------- | --------- | --- | -------------- | ---------- |
109+
| `az network dns zone list` | All | Core | yes | | |
110+
| `az network dns zone create` | `--name`, `--resource-group`, `--if-none-match`, `--parent-name` | Core | yes | | |
111+
| | `--existingParameter5` | Core | | | yes |
112+
| | `--newParameter6` | Core | | yes | |
113+
| `az network vhub list` | All | Extension | yes | | |
114+
| `az network vhub create` | `--address-prefix`, `--name`, `--resource-group`, `-vwan`, `--location`, `--sku` | Extension | yes | | |
115+
| | `--existingParameter7` | Extension | | yes | |
116+
| | `--newParameter8` | Extension | yes | | |
117+
| `az network firewall create` | All | Extension | | yes | |
118+
119+
The previous table is only an example and doesn't represent the current reference statuses for
120+
`az network`.
96121

97122
## See also
98123

99-
- [Azure CLI support lifecycle](./azure-cli-support-lifecycle.md)
124+
- [Azure CLI support lifecycle][06]
125+
126+
<!-- link references -->
127+
128+
[01]: ../../docs-ref-autogen/Latest-version/latest/config.yml
129+
[02]: ../../docs-ref-autogen/Latest-version/latest/network.yml
130+
[03]: ../../docs-ref-autogen/Latest-version/latest/pipelines.yml
131+
[04]: ../../docs-ref-autogen/Latest-version/latest/pipelines/agent.yml
132+
[05]: ../../docs-ref-autogen/Latest-version/latest/reference-index.yml
133+
[06]: ./azure-cli-support-lifecycle.md
134+
[07]: /cli/azure/extension#az-extension-add
135+
[08]: /cli/azure/extension#az-extension-list-available
136+
[09]: /cli/azure/network/application-gateway#az-network-application-gateway-create
137+
[10]: azure-cli-extensions-list.md
138+
[11]: azure-cli-extensions-overview.md
139+
[12]: https://azure.microsoft.com/support/legal/preview-supplemental-terms/
140+
[13]: install-azure-cli-windows.md

0 commit comments

Comments
 (0)