Обзор терминологии и уровней поддержки Azure CLI
В этой статье описываются термины Azure CLI. В Azure CLI есть компоненты синтаксиса, ссылочные типы и состояния.
Компоненты синтаксиса Azure CLI
Синтаксис Azure CLI представляет собой сочетание групп, ссылок, команд и параметров. Часто команда полной ссылки называется командой.
| Служба Azure | Ссылочная группа | Ссылочные подгруппы | Команда | Команда полной ссылки | Примеры параметров |
|---|---|---|---|---|---|
| Azure CLI | az config | az config | --local, --output -o | ||
| Сеть Azure | az network | application-gateway | create | az network application-gateway create | --name, --resource-group, --capacity |
| Azure DevOps | az pipelines | агент | список | az pipelines agent list | --pool-id, --agent-name, --demands |
Ссылочная подгруппа может иметь несколько уровней, например az network application-gateway private-link ip-config add.
| Ссылочная группа | Подгруппа 1 | Подгруппа 2 | Подгруппа 3 | Команда |
|---|---|---|---|---|
| сеть | application-gateway | private-link | ip-config | add |
Полный список ссылочных команд см . в списке ссылок A to Z .
Что такое ссылочный тип?
Команды Azure CLI являются частью основной службы Azure CLI или являются расширением. Расширения — это необязательные надстройки. Ссылочный тип определяет расписание выпуска, состояние и метод установки, как описано здесь:
| Термин | Основные сведения | Расширение |
|---|---|---|
| Ссылки | Являются частью основной службы Azure CLI. | Являются необязательными командами ссылки, которые должны быть установлены. |
| Установка | Совместно с помощью установщика MSI. | Отдельно с помощью az extension add. |
| Выпущено | По расписанию. | По мере появления новых функций или обновлений. |
| Состояние | Может быть общедоступной (общедоступной), предварительной версии или устаревшей версии | Кроме того, можно использовать общедоступную версию, предварительную версию или устаревшую версию. |
Чтобы получить список групп команд, выполните команду az. Чтобы получить список расширений, используйте команду az extension list-available --output table.
# Get list of all command groups
az
# Get list of extensions
az extension list-available --output table
Основные сведения
Ссылки Azure CLI, опубликованные как постоянная часть CLI, называются основными ссылками. Все основные ссылки устанавливаются с помощью Azure CLI и вы не можете выбрать подмножество ссылок. Если вы запускаете CLI с помощью Azure Cloud Shell, основные ссылки всегда будут актуальными.
Расширение
Расширения не поставляются вместе с CLI, но выполняются в виде команд CLI. Некоторые расширения являются постоянной частью Azure CLI, но часто расширение предоставляет доступ к предварительным версиям и экспериментальным командам. Отдельная ссылочная группа, например az iot hub, может включать команды основной службы и команды-расширения. Вот два примера:
| Команда полной ссылки | Основная команда | Команда расширения |
|---|---|---|
| az iot hub list | yes | |
| az iot hub job list | yes |
Вам будет предложено установить расширение при первом использовании. Вы также можете установить расширение, выполнив команду az extension add.
Сведения о расширениях, включая инструкции по их установке и обновлении, см. в статье Использование расширений с Azure CLI. Полный список команд расширения см. в статье Доступные расширения для Azure CLI.
Что такое состояние ссылки?
Независимо от типа ссылок, ссылки Azure CLI делятся на три категории состояния: ga (общедоступная версия), общедоступная предварительная версия или нерекомендуемые. Это состояние ссылочной команды (не тип), определяющее стабильность.
| Общедоступная версия | Общедоступная предварительная версия | Устарело | |
|---|---|---|---|
| Стабильность | Постоянный | Могут изменяться в ответ на отзывы клиентов. Регулируются условиями использования предварительных версий продуктов Microsoft Azure. | Будет удален. |
Примечание.
Предупреждения, указывающие на общедоступную предварительную версию или устаревшие , являются частью выходных данных команды Azure CLI и должны быть ожидаемыми.
Большинство команд и параметров для одной ссылки имеют одно состояние, но не всегда. Ссылка на общедоступную версию, созданная для предоставления дополнительных команд, может содержать команды общедоступной версии и предварительной версии ссылок. Кроме того, при добавлении новых параметров для повышения функциональности одна команда может иметь параметры, которые используются в разных категориях состояния. Ниже приведены примеры ссылок с разными состояниями.
| Команда полной ссылки | Параметры | Тип | Общедоступная версия | Общедоступная предварительная версия | Устарело |
|---|---|---|---|---|---|
| az network dns zone list | Все | Основные сведения | yes | ||
| az network dns zone create | --name, --resource-group, --if-none-match, --parent-name | Основные сведения | yes | ||
| --existingParameter5 | Основные сведения | yes | |||
| --newParameter6 | Основные сведения | yes | |||
| az network vhub list | Все | Extension | yes | ||
| az network vhub create | --address-prefix, --name, --resource-group, -vwan, --location, --sku | Extension | yes | ||
| --exsitingParameter7 | Extension | yes | |||
| --newParameter8 | Extension | yes | |||
| az network firewall create | Все | Extension | yes |
Приведенная выше таблица является только примером и не является представителем текущих ссылочных состояний для az network.
