az k8s-extension
Note
このリファレンスは、Azure CLI (バージョン 2.51.0 以降) の k8s 拡張機能の一部です。 拡張機能は、az k8s-extension コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
Kubernetes 拡張機能を管理するコマンド。
コマンド
名前 | 説明 | 型 | Status |
---|---|---|---|
az k8s-extension create |
Azure Marketplace からの拡張機能オファーの購入を含む Kubernetes クラスター拡張機能を作成します (AKS のみ)。 拡張機能を作成する方法や拡張機能オファーを購入する方法については、最後の例を参照してください。 |
拡張機能 | GA |
az k8s-extension delete |
Kubernetes 拡張機能を削除します。 |
拡張機能 | GA |
az k8s-extension extension-types |
Kubernetes 拡張機能の種類を検出するコマンド。 |
拡張機能 | プレビュー |
az k8s-extension extension-types list |
既存のクラスターで使用可能なクラスター拡張機能の種類を一覧表示します。 |
拡張機能 | プレビューと非推奨 |
az k8s-extension extension-types list-by-cluster |
既存のクラスターで使用可能なクラスター拡張機能の種類を一覧表示します。 フィルター処理に使用されるプロパティには、クラスターの種類 (マネージド、接続など)、kubernetes バージョン、クラスターの場所などがあります。 |
拡張機能 | プレビュー |
az k8s-extension extension-types list-by-location |
リージョンで使用可能なクラスター拡張機能の種類を一覧表示します。 |
拡張機能 | プレビュー |
az k8s-extension extension-types list-versions |
特定のクラスターのクラスター拡張機能の種類で使用可能なバージョンを一覧表示します。 |
拡張機能 | プレビューと非推奨 |
az k8s-extension extension-types list-versions-by-cluster |
特定のクラスターのクラスター拡張機能の種類で使用可能なバージョンを一覧表示します。 フィルター処理に使用されるプロパティには、クラスターの種類 (マネージド、接続など)、kubernetes バージョン、クラスターの場所などがあります。 |
拡張機能 | プレビュー |
az k8s-extension extension-types list-versions-by-location |
リージョン内のクラスター拡張機能の種類のバージョンで使用可能なバージョンを一覧表示します。 |
拡張機能 | プレビュー |
az k8s-extension extension-types show |
リージョン内のクラスター拡張機能の種類のプロパティを取得します。 |
拡張機能 | プレビューと非推奨 |
az k8s-extension extension-types show-by-cluster |
既存のクラスターのクラスター拡張機能の種類のプロパティを表示します。 フィルター処理に使用されるプロパティには、クラスターの種類 (マネージド、接続など)、kubernetes バージョン、クラスターの場所などがあります。 |
拡張機能 | プレビュー |
az k8s-extension extension-types show-by-location |
リージョン内のクラスター拡張機能の種類のプロパティを表示します。 |
拡張機能 | プレビュー |
az k8s-extension extension-types show-version-by-cluster |
既存のクラスターのクラスター拡張機能の種類のバージョンに関連付けられているプロパティを表示します。 フィルター処理に使用されるプロパティには、クラスターの種類 (マネージド、接続など)、kubernetes バージョン、クラスターの場所などがあります。 |
拡張機能 | プレビュー |
az k8s-extension extension-types show-version-by-location |
リージョン内のクラスター拡張機能の種類のバージョンに関連付けられているプロパティを表示します。 |
拡張機能 | プレビュー |
az k8s-extension list |
Kubernetes 拡張機能を一覧表示します。 |
拡張機能 | GA |
az k8s-extension show |
Kubernetes 拡張機能を表示します。 |
拡張機能 | GA |
az k8s-extension update |
Kubernetes 拡張機能の変更可能なプロパティを更新します。 |
拡張機能 | GA |
az k8s-extension create
Azure Marketplace からの拡張機能オファーの購入を含む Kubernetes クラスター拡張機能を作成します (AKS のみ)。 拡張機能を作成する方法や拡張機能オファーを購入する方法については、最後の例を参照してください。
Kubernetes 拡張機能を作成します。 出力には、保護する必要があるシークレットが含まれます。 これらのシークレットをソース管理に含めないようにしてください。 また、コマンドまたはスクリプトのログにシークレットがないことを確認します。 詳細については、http://aka.ms/clisecrets を参照してください。
az k8s-extension create --cluster-name
--cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
--extension-type
--name
--resource-group
[--auto-upgrade {false, true}]
[--cluster-resource-provider]
[--config]
[--config-file]
[--config-protected]
[--config-protected-file]
[--config-settings]
[--configuration-protected-settings]
[--configuration-protected-settings-file]
[--configuration-settings-file]
[--no-wait]
[--plan-name]
[--plan-product]
[--plan-publisher]
[--release-namespace]
[--release-train]
[--scope {cluster, namespace}]
[--target-namespace]
[--version]
例
Kubernetes 拡張機能を作成する
az k8s-extension create --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension --extension-type microsoft.openservicemesh --scope cluster --release-train stable
Kubernetes Marketplace 拡張機能を作成する
az k8s-extension create --resource-group my-resource-group --cluster-name mycluster --cluster-type managedClusters --name myextension --extension-type Contoso.AzureVoteKubernetesAppTest --scope cluster --release-train stable --plan-name testplan --plan-product kubernetest_apps_demo_offer --plan-publisher test_test_mix3pptest0011614206850774
必須のパラメーター
Kubernetes クラスターの名前。
Arc クラスターまたは AKS マネージド クラスター、Arc アプライアンス、または provisionedClusters を指定します。
拡張機能の種類の名前。
拡張機能インスタンスの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
拡張機能インスタンスのマイナー バージョンを自動的にアップグレードします。
この clusterType のクラスター リソース プロバイダー名 (provisionedClusters に必要)。
キーと値のペアとしての構成設定。 各設定に対してパラメーターを繰り返します。 この値は応答で返されるため、シークレットには使用しないでください。
構成設定の JSON ファイル パス。
構成保護された設定キーと値のペア。 各設定に対してパラメーターを繰り返します。 応答ではキーのみが返され、値は返されません。
configuration-protected-settings の JSON ファイル パス。
オプション '--config-settings' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--configuration-settings' を使用してください。
キーと値のペアとしての構成設定。 各設定に対してパラメーターを繰り返します。 この値は応答で返されるため、シークレットには使用しないでください。
オプション '--configuration-protected-settings' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--config-protected-settings' を使用してください。
構成保護された設定キーと値のペア。 各設定に対してパラメーターを繰り返します。 応答ではキーのみが返され、値は返されません。
オプション '--configuration-protected-settings-file' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--config-protected-file' を使用してください。
configuration-protected-settings の JSON ファイル パス。
オプション '--configuration-settings-file' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--config-settings-file' を使用してください。
構成設定の JSON ファイル パス。
実行時間の長い操作の終了を待機しません。
プラン名は、Marketplace ポータルの [使用状況情報とサポート] で取得される拡張機能のプラン ID を参照しています。
プラン製品は、Marketplace ポータルの [使用状況情報とサポート] で取得される拡張機能の製品 ID を参照しています。 この例は、使用される ISV オファリングの名前です。
プランの発行元は、Marketplace ポータルの [使用状況情報とサポート] で取得される拡張機能の発行元 ID を参照しています。
拡張機能リリースをインストールする名前空間を指定します。
拡張タイプのリリース トレーニングを指定します。
拡張機能のスコープを指定します。
拡張機能インスタンスのインストール先の名前空間を指定します。 拡張スコープが 'namespace' に設定されている場合は、このパラメーターが必要です。
--auto-upgrade-minor-version が有効になっていない場合は、拡張機能インスタンスにインストールするバージョンを指定します。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az k8s-extension delete
Kubernetes 拡張機能を削除します。
az k8s-extension delete --cluster-name
--cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
--name
--resource-group
[--cluster-resource-provider]
[--force]
[--no-wait]
[--yes]
例
既存の Kubernetes 拡張機能を削除する
az k8s-extension delete --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension
必須のパラメーター
Kubernetes クラスターの名前。
Arc クラスターまたは AKS マネージド クラスター、Arc アプライアンス、または provisionedClusters を指定します。
拡張機能インスタンスの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
この clusterType のクラスター リソース プロバイダー名 (provisionedClusters に必要)。
クラスターから拡張機能を強制的に削除するかどうかを指定します。
実行時間の長い操作の終了を待機しません。
確認プロンプトを無視します。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az k8s-extension list
Kubernetes 拡張機能を一覧表示します。
クラスター内のすべての Kubernetes 拡張機能 (プロパティを含む) を一覧表示します。 出力には、保護する必要があるシークレットが含まれます。 これらのシークレットをソース管理に含めないようにしてください。 また、コマンドまたはスクリプトのログにシークレットがないことを確認します。 詳細については、http://aka.ms/clisecrets を参照してください。
az k8s-extension list --cluster-name
--cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
--resource-group
[--cluster-resource-provider]
例
クラスター上のすべての Kubernetes 拡張機能を一覧表示する
az k8s-extension list --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters
必須のパラメーター
Kubernetes クラスターの名前。
Arc クラスターまたは AKS マネージド クラスター、Arc アプライアンス、または provisionedClusters を指定します。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
この clusterType のクラスター リソース プロバイダー名 (provisionedClusters に必要)。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az k8s-extension show
Kubernetes 拡張機能を表示します。
プロパティを含む Kubernetes 拡張機能を表示します。 出力には、保護する必要があるシークレットが含まれます。 これらのシークレットをソース管理に含めないようにしてください。 また、コマンドまたはスクリプトのログにシークレットがないことを確認します。 詳細については、http://aka.ms/clisecrets を参照してください。
az k8s-extension show --cluster-name
--cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
--name
--resource-group
[--cluster-resource-provider]
例
Kubernetes 拡張機能の詳細を表示する
az k8s-extension show --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension
必須のパラメーター
Kubernetes クラスターの名前。
Arc クラスターまたは AKS マネージド クラスター、Arc アプライアンス、または provisionedClusters を指定します。
拡張機能インスタンスの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
この clusterType のクラスター リソース プロバイダー名 (provisionedClusters に必要)。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az k8s-extension update
Kubernetes 拡張機能の変更可能なプロパティを更新します。
Config設定 および ConfigProtected設定 への更新については、これらのプロパティを更新する前に、これらのプロパティの更新がサポートチェッククラスター拡張機能サービスのドキュメントを参照してください。 出力には、保護する必要があるシークレットが含まれます。 これらのシークレットをソース管理に含めないようにしてください。 また、コマンドまたはスクリプトのログにシークレットがないことを確認します。 詳細については、http://aka.ms/clisecrets を参照してください。
az k8s-extension update --cluster-name
--cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
--name
--resource-group
[--auto-upgrade {false, true}]
[--cluster-resource-provider]
[--config]
[--config-file]
[--config-protected]
[--config-protected-file]
[--config-settings]
[--configuration-protected-settings]
[--configuration-protected-settings-file]
[--configuration-settings-file]
[--no-wait]
[--release-train]
[--version]
[--yes]
例
Kubernetes 拡張機能を更新する
az k8s-extension update --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension --auto-upgrade true/false --version extension-version --release-train stable --configuration-settings settings-key=settings-value --config-protected-settings protected-settings-key=protected-value --config-settings-file=config-settings-file --config-protected-file=protected-settings-file
必須のパラメーター
Kubernetes クラスターの名前。
Arc クラスターまたは AKS マネージド クラスター、Arc アプライアンス、または provisionedClusters を指定します。
拡張機能インスタンスの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
拡張機能インスタンスのマイナー バージョンを自動的にアップグレードします。
この clusterType のクラスター リソース プロバイダー名 (provisionedClusters に必要)。
キーと値のペアとしての構成設定。 各設定に対してパラメーターを繰り返します。 この値は応答で返されるため、シークレットには使用しないでください。
構成設定の JSON ファイル パス。
構成保護された設定キーと値のペア。 各設定に対してパラメーターを繰り返します。 応答ではキーのみが返され、値は返されません。
configuration-protected-settings の JSON ファイル パス。
オプション '--config-settings' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--configuration-settings' を使用してください。
キーと値のペアとしての構成設定。 各設定に対してパラメーターを繰り返します。 この値は応答で返されるため、シークレットには使用しないでください。
オプション '--configuration-protected-settings' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--config-protected-settings' を使用してください。
構成保護された設定キーと値のペア。 各設定に対してパラメーターを繰り返します。 応答ではキーのみが返され、値は返されません。
オプション '--configuration-protected-settings-file' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--config-protected-file' を使用してください。
configuration-protected-settings の JSON ファイル パス。
オプション '--configuration-settings-file' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--config-settings-file' を使用してください。
構成設定の JSON ファイル パス。
実行時間の長い操作の終了を待機しません。
拡張タイプのリリース トレーニングを指定します。
--auto-upgrade-minor-version が有効になっていない場合は、拡張機能インスタンスにインストールするバージョンを指定します。
確認プロンプトを無視します。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI