概要: Azure CLI の用語とサポート レベル
この記事では、Azure CLI の用語について説明します。 構文コンポーネント、参照型、状態があります。 サポート レベルを決定するのは、状態です。
Azure CLI 構文コンポーネント
Azure CLI 構文は、グループ、参照、コマンド、パラメーターを組み合わせたものです。 多くの場合、完全な参照コマンドは、コマンドと呼ばれます。
| Azure サービス | 参照グループ | 参照サブグループ | command | 完全参照コマンド | パラメーターの例 |
|---|---|---|---|---|---|
| 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 | エージェント | list | 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 -Z を参照してください。
参照型とは
Azure CLI コマンドは、コア Azure CLI サービスの一部であるか、拡張機能のどちらかです。 拡張機能はオプションのアドオンです。 ここで説明されているように、参照型によって、リリース スケジュール、状態、インストール方法が決まります。
| 期間 | コア | 拡張機能 |
|---|---|---|
| 参照 | プライマリ Azure CLI サービスの一部 | インストールする必要があるオプションの参照コマンド |
| インストール | MSI インストーラーと一緒に | az extension add で個別に |
| リリース | [スケジュールに従う] | 新しい機能や更新プログラムが利用可能になったとき |
| 状態 | GA (一般提供)、プレビュー、または実験用 | 同様に、GA、プレビュー、または実験用 |
コマンド グループの一覧を取得するには az を実行します。 拡張機能の一覧には az extension list-available --output table コマンドを使います。
# Get list of all command groups
az
# Get list of extensions
az extension list-available --output table
コア
CLI の永続的な部分として公開されている Azure CLI 参照は、コア参照と呼ばれます。 すべてのコア参照は Azure CLI と共にインストールされます。参照のサブセットを選択することはできません。 Azure Cloud Shell を通じて CLI を実行する場合、コア参照は常に最新の状態になります。
拡張機能
拡張機能は、CLI の一部として付属しませんが、CLI コマンドとして実行されます。 一部の拡張機能は Azure CLI の永続的な部分ですが、多くの場合、拡張機能によって、プレビューや実験用コマンドにアクセスできるようになります。 az iot hub などの 1 つの参照グループが、コアと拡張機能の両方のコマンドを持つことがあります。 次に 2 つの例を示します。
| 完全参照コマンド | コア | 拡張機能 |
|---|---|---|
| az iot hub list | はい | |
| az iot hub job list | はい |
最初の使用時に拡張機能をインストールするように求められます。 また、az extension add コマンドを実行することでも、拡張機能をインストールできます。
インストールと更新を含む拡張機能の参照について詳しくは、「Azure CLI で拡張機能を使用する」を参照してください。 拡張機能参照コマンドの完全な一覧については、「Azure CLI で使用可能な拡張機能」を参照してください。
参照状態とは
参照型に関係なく、Azure CLI 参照は次の 3 つの状態カテゴリに分類されます。GA (一般提供)、パブリック プレビュー、または実験用。 安定性とサポート レベルを決定するのは、型ではなく、参照コマンドの状態です。
| GA | パブリック プレビュー | 実験用 | |
|---|---|---|---|
| 安定性 | 永続的 | カスタマー フィードバックに応じて変更される場合があります。 Microsoft Azure プレビューの条件に従います。 | カスタマー フィードバックに応じて変更される場合があります。 多くの場合、パブリック プレビューに移行されます。 削除される場合があります。 |
| サポート レベル | [完全] | Partial | なし |
Note
パブリック プレビューまたは実験用を示す警告は、Azure CLI コマンドの出力の一部であり、予期されるものです。
1 つの参照に対するほとんどのコマンドとパラメーターには 1 つの状態がありますが、常にそうではありません。 より多くのコマンドを提供するために構築されている GA 参照は、GA、プレビュー、および実験用の参照コマンドを持つことがあります。 機能を向上させるために新しいパラメーターが追加されるときに、1 つのコマンドが、異なる状態カテゴリに分類されるパラメーターを持つこともあります。 異なる状態を持つ参照の例を次に示します。
| 完全参照コマンド | パラメーター | 種類 | GA | パブリック プレビュー | 実験用 |
|---|---|---|---|---|---|
| az network dns zone list | すべて | コア | はい | ||
| az network dns zone create | --name, --resource-group, --if-none-match, --parent-name | コア | はい | ||
| --newFutureParameter1 | コア | はい | |||
| --newFutureParameter2 | コア | はい | |||
| az network vhub list | すべて | 拡張機能 | はい | ||
| az network vhub create | --address-prefix, --name, --resource-group, -vwan, --location, --sku | 拡張機能 | はい | ||
| --newFutureParameter1 | 拡張機能 | はい | |||
| --newFutureParameter2 | 拡張機能 | はい | |||
| az network firewall create | すべて | 拡張機能 | はい |
上の表はあくまで一例であり、現在の参照状態を代表する例ではありません。