az k8s-extension

  • 參考

注意

此參考是 Azure CLI 的 k8s 擴充功能延伸模組的一部分（2.51.0 版或更高版本）。 擴充功能會在您第一次執行 az k8s-extension 命令時自動安裝。 深入了解擴充功能。

管理 Kubernetes 延伸模組的命令。

命令

名稱 Description 類型 狀態
az k8s-extension create

建立 Kubernetes 叢集擴充功能，包括從 Azure Marketplace 購買擴充功能供應專案（僅限 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

建立 Kubernetes 叢集擴充功能，包括從 Azure Marketplace 購買擴充功能供應專案（僅限 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

必要參數

--cluster-name -c

Kubernetes 叢集的名稱。

--cluster-type -t

指定 Arc 叢集或 AKS 受控叢集或 Arc 設備或 provisionedCluster。

接受的值: appliances, connectedClusters, managedClusters, provisionedClusters
--extension-type

延伸模組類型的名稱。

--name -n

擴充實例的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

選擇性參數

--auto-upgrade --auto-upgrade-minor-version

自動升級擴充實例的次要版本。

接受的值: false, true
--cluster-resource-provider --cluster-rp

此 clusterType 的叢集資源提供者名稱（provisionedClusters 的必要專案）。

--config --configuration-settings

組態設定為 key=value 組。 針對每個設定重複參數。 請勿將此值用於秘密，因為此值會在回應中傳回。

--config-file --config-settings-file

組態設定的 JSON 檔案路徑。

--config-protected --config-protected-settings

設定受保護的設定作為 key=value 組。 針對每個設定重複參數。 只有索引鍵會在回應中傳回，值不是。

--config-protected-file --config-protected-settings-file

組態保護設定的 JSON 檔案路徑。

--config-settings
已被取代

選項 '--config-settings' 已被取代，將在未來的版本中移除。 請改用 '--configuration-settings'。

組態設定為 key=value 組。 針對每個設定重複參數。 請勿將此值用於秘密，因為此值會在回應中傳回。

--configuration-protected-settings
已被取代

選項 '--configuration-protected-settings' 已被取代，並將在未來版本中移除。 請改用 '--config-protected-settings'。

設定受保護的設定作為 key=value 組。 針對每個設定重複參數。 只有索引鍵會在回應中傳回，值不是。

--configuration-protected-settings-file
已被取代

選項 '--configuration-protected-settings-file' 已被取代，未來版本將會移除。 請改用 '--config-protected-file'。

組態保護設定的 JSON 檔案路徑。

--configuration-settings-file
已被取代

選項 '--configuration-settings-file' 已被取代，並將在未來版本中移除。 請改用 '--config-settings-file'。

組態設定的 JSON 檔案路徑。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False
--plan-name

方案名稱指的是在 [使用資訊 + 支援] 底下從 Marketplace 入口網站取得之延伸模組的方案識別碼。

--plan-product

方案產品指的是在 [使用資訊 + 支援] 底下從 Marketplace 入口網站取得之延伸模組的產品識別符。 其中一個範例是所使用的ISV供應項目名稱。

--plan-publisher

方案發行者指的是從 Marketplace 入口網站 [使用資訊 + 支援] 底下取得之延伸模組的發行者標識符。

--release-namespace

指定要安裝擴充功能的命名空間。

--release-train

指定擴充類型的發行定型。

--scope

指定延伸模組範圍。

接受的值: cluster, namespace
--target-namespace

指定要針對延伸模組實例安裝的目標命名空間。 如果擴充範圍設定為 『namespace』，則需要此參數。

--version

如果未啟用 --auto-upgrade-minor-version，請指定要為擴充實例安裝的版本。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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

必要參數

--cluster-name -c

Kubernetes 叢集的名稱。

--cluster-type -t

指定 Arc 叢集或 AKS 受控叢集或 Arc 設備或 provisionedCluster。

接受的值: appliances, connectedClusters, managedClusters, provisionedClusters
--name -n

擴充實例的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

選擇性參數

--cluster-resource-provider --cluster-rp

此 clusterType 的叢集資源提供者名稱（provisionedClusters 的必要專案）。

--force

指定是否要強制從叢集刪除延伸模組。

預設值: False
--no-wait

請勿等候長時間執行的作業完成。

預設值: False
--yes -y

忽略確認提示。

預設值: False
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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

必要參數

--cluster-name -c

Kubernetes 叢集的名稱。

--cluster-type -t

指定 Arc 叢集或 AKS 受控叢集或 Arc 設備或 provisionedCluster。

接受的值: appliances, connectedClusters, managedClusters, provisionedClusters
--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

選擇性參數

--cluster-resource-provider --cluster-rp

此 clusterType 的叢集資源提供者名稱（provisionedClusters 的必要專案）。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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

必要參數

--cluster-name -c

Kubernetes 叢集的名稱。

--cluster-type -t

指定 Arc 叢集或 AKS 受控叢集或 Arc 設備或 provisionedCluster。

接受的值: appliances, connectedClusters, managedClusters, provisionedClusters
--name -n

擴充實例的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

選擇性參數

--cluster-resource-provider --cluster-rp

此 clusterType 的叢集資源提供者名稱（provisionedClusters 的必要專案）。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --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

必要參數

--cluster-name -c

Kubernetes 叢集的名稱。

--cluster-type -t

指定 Arc 叢集或 AKS 受控叢集或 Arc 設備或 provisionedCluster。

接受的值: appliances, connectedClusters, managedClusters, provisionedClusters
--name -n

擴充實例的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

選擇性參數

--auto-upgrade --auto-upgrade-minor-version

自動升級擴充實例的次要版本。

接受的值: false, true
--cluster-resource-provider --cluster-rp

此 clusterType 的叢集資源提供者名稱（provisionedClusters 的必要專案）。

--config --configuration-settings

組態 設定 為key=value組。 針對每個設定重複參數。 請勿將此值用於秘密，因為此值會在響應中傳回。

--config-file --config-settings-file

組態設定的 JSON 檔案路徑。

--config-protected --config-protected-settings

設定受保護的 設定 作為key=value組。 針對每個設定重複參數。 只有索引鍵會在響應中傳回，值不是。

--config-protected-file --config-protected-settings-file

組態保護設定的 JSON 檔案路徑。

--config-settings
已被取代

選項 '--config-settings' 已被取代，將在未來的版本中移除。 請改用 『--configuration-settings』。

組態 設定 為key=value組。 針對每個設定重複參數。 請勿將此值用於秘密，因為此值會在響應中傳回。

--configuration-protected-settings
已被取代

選項 '--configuration-protected-settings' 已被取代，並將在未來版本中移除。 請改用 『--config-protected-settings』。

設定受保護的 設定 作為key=value組。 針對每個設定重複參數。 只有索引鍵會在響應中傳回，值不是。

--configuration-protected-settings-file
已被取代

選項 '--configuration-protected-settings-file' 已被取代，未來版本將會移除。 請改用 『--config-protected-file』。

組態保護設定的 JSON 檔案路徑。

--configuration-settings-file
已被取代

選項 '--configuration-settings-file' 已被取代，並將在未來版本中移除。 請改用 『--config-settings-file』。

組態設定的 JSON 檔案路徑。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False
--release-train

指定擴充類型的發行定型。

--version

如果未啟用 --auto-upgrade-minor-version，請指定要為擴充實例安裝的版本。

--yes -y

忽略確認提示。

預設值: False
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。