この記事では、Azure CLI の用語について説明します。 構文コンポーネント、参照型、および状態があります。
Azure CLI 構文コンポーネント
Azure CLI 構文は、グループ、参照、コマンド、パラメーターの組み合わせです。 多くの場合、完全参照コマンド は、コマンドと呼ばれます。
| Azure サービス | 参照グループ | 参照サブグループ | コマンド | 完全参照コマンド | パラメーターの例 |
|---|---|---|---|---|---|
| Azure CLI（Azure コマンドライン インターフェイス） | az config | az config | --local、--output -o | ||
| Azure Network | az network | アプリケーションゲートウェイ | 創造する | 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 | コマンド |
|---|---|---|---|---|
| ネットワーク | アプリケーションゲートウェイ | プライベートリンク | IP設定 | 追加する |
参照コマンドの完全な一覧については、参照リスト A から Z を参照してください。
参照型とは
Azure CLI コマンドは、Azure CLI サービス コアの一部であるか、拡張機能です。 拡張機能は省略可能なアドオンです。 参照の種類は、次に示すようにリリース スケジュール、状態、およびインストール方法を決定します。
| 任期 | コア | 拡張 |
|---|---|---|
| 参考文献 | プライマリ Azure CLI サービスの一部である | インストール可能なオプションの参照コマンド |
| インストール | MSI インストーラー と共同で | az 拡張機能を使用して ごとに を追加します。 |
| リリースされた | [スケジュールに従う] | 新機能または更新プログラムが利用可能になると |
| 地位 | 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 コマンドを使用して、IoT ハブを一覧表示します。 | はい | |
| az iot hub のジョブリスト コマンド | はい |
初回使用時に拡張機能をインストールするように求められます。 az extension add コマンドを実行して拡張機能をインストールすることもできます。
インストールや更新を含む拡張機能参照の詳細については、「Azure CLIで拡張機能を使用する」を参照してください。 拡張機能リファレンス コマンドの完全な一覧については、「Azure CLI で使用可能な拡張機能」を参照してください。
参照状態とは
参照の種類に関係なく、Azure CLI 参照は、GA (一般公開)、パブリック プレビュー 、非推奨の の 3 つのカテゴリ分類されます。 これは、安定性を決定する参照コマンドの状態 (型ではありません) です。
| ジョージア州 (GA) | パブリック プレビュー | 推奨されない | |
|---|---|---|---|
| 安定性 | パーマネント | 顧客からのフィードバックに応じて変更できます。 Microsoft Azure プレビューの使用条件に従います。 | 削除されます。 |
注
パブリック プレビュー または非推奨 を示す警告は、Azure CLI コマンド出力の一部であり、想定される必要があります。
1 つの参照のほとんどのコマンドとパラメーターの状態は 1 つですが、常にではありません。 より多くのコマンドを提供するために組み込まれている GA 参照には、GA とプレビューの両方の参照コマンドを含めることができます。 機能を向上させるために新しいパラメーターが追加されると、1 つのコマンドに、さまざまなステータス カテゴリに分類されるパラメーターを指定することもできます。 状態が異なる参照例を次に示します。
| 完全参照コマンド | パラメーター | タイプ | ジョージア州 (GA) | パブリック プレビュー | 推奨されない |
|---|---|---|---|---|---|
| az ネットワーク DNS ゾーン リスト | 全て | コア | はい | ||
| az network dns zone create コマンド | --name、--resource-group、--if-none-match、--parent-name | コア | はい | ||
| --existingParameter5 | コア | はい | |||
| --newParameter6 | コア | はい | |||
| az network vhub list（これはネットワークにおける仮想ハブの一覧を表示するコマンドです） | 全て | 拡張 | はい | ||
| az network vhub create | --address-prefix、--name、--resource-group、-vwan、--___location、--sku | 拡張 | はい | ||
| --exsitingParameter7 | 拡張 | はい | |||
| --newParameter8 | 拡張 | はい | |||
| az network firewall create コマンドを実行する | 全て | 拡張 | はい |
上記の表は一例に過ぎません。az networkの現在の参照状態を表すわけではありません。
こちらも参照ください
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Azure CLI