az k8s-extension

Note

Эта ссылка является частью расширения k8s-extension для Azure CLI (версия 2.51.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az k8s-extension . Подробнее о расширениях.

Команды для управления расширениями Kubernetes.

Команды

Имя	Описание	Тип	Состояние
az k8s-extension create	Создайте расширение кластера Kubernetes, включая приобретение предложения расширения из Azure Marketplace (только AKS). Ознакомьтесь с примером в конце, чтобы узнать, как создать расширение или приобрести предложение расширения.	Extension	GA
az k8s-extension delete	Удаление расширения Kubernetes.	Extension	GA
az k8s-extension extension-types	Команды для обнаружения типов расширений Kubernetes.	Extension	Preview
az k8s-extension extension-types list-by-cluster	Список доступных типов расширений кластера для существующего кластера. Свойства, используемые для фильтрации, включают тип кластера (управляемый, подключенный и т. д.), версию kubernetes, расположение кластера.	Extension	Preview
az k8s-extension extension-types list-by-location	Список доступных типов расширений кластера в регионе.	Extension	Preview
az k8s-extension extension-types list-versions-by-cluster	Список доступных версий для типа расширения кластера для данного кластера. Свойства, используемые для фильтрации, включают тип кластера (управляемый, подключенный и т. д.), версию kubernetes, расположение кластера.	Extension	Preview
az k8s-extension extension-types list-versions-by-location	Список доступных версий для версий типа расширения кластера в регионе.	Extension	Preview
az k8s-extension extension-types show-by-cluster	Отображение свойств для типа расширения кластера для существующего кластера. Свойства, используемые для фильтрации, включают тип кластера (управляемый, подключенный и т. д.), версию kubernetes, расположение кластера.	Extension	Preview
az k8s-extension extension-types show-by-location	Отображение свойств типа расширения кластера в регионе.	Extension	Preview
az k8s-extension extension-types show-version-by-cluster	Отображение свойств, связанных с версией типа расширения кластера для существующего кластера. Свойства, используемые для фильтрации, включают тип кластера (управляемый, подключенный и т. д.), версию kubernetes, расположение кластера.	Extension	Preview
az k8s-extension extension-types show-version-by-location	Отображение свойств, связанных с версией типа расширения кластера в регионе.	Extension	Preview
az k8s-extension list	Перечисление расширений Kubernetes.	Extension	GA
az k8s-extension show	Показать расширение Kubernetes.	Extension	GA
az k8s-extension troubleshoot	Выполните диагностические проверки расширения Kubernetes.	Extension	Preview
az k8s-extension update	Обновите изменяемые свойства расширения Kubernetes.	Extension	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 --auto-upgrade-minor-version {false, true}]
                        [--cluster-resource-provider --cluster-rp]
                        [--config --configuration-settings]
                        [--config-file --config-settings-file]
                        [--config-protected --config-protected-settings]
                        [--config-protected-file --config-protected-settings-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 или подготовленныеclusters.

Свойство	Значение
Допустимые значения:	appliances, connectedClusters, managedClusters, provisionedClusters

--extension-type

Имя типа расширения.

--name -n

Имя экземпляра расширения.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Автоматическое обновление дополнительной версии экземпляра расширения.

Свойство	Значение
Parameter group:	Version Arguments
Допустимые значения:	false, true

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

Имя поставщика ресурсов кластера для этого clusterType (требуется для подготовкиclusters).

--config --configuration-settings

Параметры конфигурации в качестве пары key=value. Повторите параметр для каждого параметра. Не используйте это для секретов, так как это значение возвращается в ответ.

Свойство	Значение
Parameter group:	Configuration Arguments

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

Путь к файлу JSON для параметров конфигурации.

Свойство	Значение
Parameter group:	Configuration Arguments

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

Защищенные параметры конфигурации в качестве пары key=value. Повторите параметр для каждого параметра. Только ключ возвращается в ответ, значение не является.

Свойство	Значение
Parameter group:	Configuration Arguments

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

Путь к JSON-файлу для параметров, защищенных конфигурацией.

Свойство	Значение
Parameter group:	Configuration Arguments

--config-settings

Не рекомендуется

Параметр "--config-settings" устарел и будет удален в будущем выпуске. Вместо этого используйте "--configuration-settings".

Параметры конфигурации в качестве пары key=value. Повторите параметр для каждого параметра. Не используйте это для секретов, так как это значение возвращается в ответ.

Свойство	Значение
Parameter group:	Configuration Arguments

--configuration-protected-settings

Не рекомендуется

Параметр "--configuration-protected-settings" устарел и будет удален в будущем выпуске. Вместо этого используйте "--config-protected-settings".

Защищенные параметры конфигурации в качестве пары key=value. Повторите параметр для каждого параметра. Только ключ возвращается в ответ, значение не является.

Свойство	Значение
Parameter group:	Configuration Arguments

--configuration-protected-settings-file

Не рекомендуется

Параметр "--configuration-protected-settings-file" устарел и будет удален в будущем выпуске. Вместо этого используйте "--config-protected-file".

Путь к JSON-файлу для параметров, защищенных конфигурацией.

Свойство	Значение
Parameter group:	Configuration Arguments

--configuration-settings-file

Не рекомендуется

Параметр "-configuration-settings-file" устарел и будет удален в будущем выпуске. Вместо этого используйте "--config-settings-file".

Путь к файлу JSON для параметров конфигурации.

Свойство	Значение
Parameter group:	Configuration Arguments

--no-wait

Не ожидать завершения длительной операции.

Свойство	Значение
Default value:	False

--plan-name

Имя плана ссылается на идентификатор плана расширения, которое берется с портала Marketplace в разделе "Сведения об использовании и поддержка".

Свойство	Значение
Parameter group:	Marketplace Arguments

--plan-product

Продукт плана ссылается на идентификатор продукта расширения, взятого с портала Marketplace в разделе "Сведения об использовании и поддержка". Примером этого является имя используемого предложения ISV.

Свойство	Значение
Parameter group:	Marketplace Arguments

--plan-publisher

Издатель плана ссылается на идентификатор издателя расширения, взятого с портала Marketplace в разделе "Сведения об использовании и поддержка".

Свойство	Значение
Parameter group:	Marketplace Arguments

--release-namespace

Укажите пространство имен для установки выпуска расширения.

--release-train

Укажите обучение выпуска для типа расширения.

Свойство	Значение
Parameter group:	Version Arguments

--scope

Укажите область расширения.

Свойство	Значение
Допустимые значения:	cluster, namespace

--target-namespace

Укажите целевое пространство имен для экземпляра расширения. Этот параметр требуется, если для области расширения задано значение "пространство имен".

--version

Укажите версию для экземпляра расширения, если не включена версия --auto-upgrade-minor-version.

Свойство	Значение
Parameter group:	Version Arguments

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False

az k8s-extension delete

Удаление расширения Kubernetes.

az k8s-extension delete --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --name
                        --resource-group
                        [--cluster-resource-provider --cluster-rp]
                        [--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 или подготовленныеclusters.

Свойство	Значение
Допустимые значения:	appliances, connectedClusters, managedClusters, provisionedClusters

--name -n

Имя экземпляра расширения.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Имя поставщика ресурсов кластера для этого clusterType (требуется для подготовкиclusters).

--force

Укажите, следует ли принудительно удалить расширение из кластера.

Свойство	Значение
Default value:	False

--no-wait

Не ожидать завершения длительной операции.

Свойство	Значение
Default value:	False

--yes -y

Игнорировать запросы подтверждения.

Свойство	Значение
Default value:	False

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False

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 --cluster-rp]

Примеры

Вывод списка всех расширений 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 или подготовленныеclusters.

Свойство	Значение
Допустимые значения:	appliances, connectedClusters, managedClusters, provisionedClusters

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Имя поставщика ресурсов кластера для этого clusterType (требуется для подготовкиclusters).

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False

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 --cluster-rp]

Примеры

Отображение сведений о расширении 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 или подготовленныеclusters.

Свойство	Значение
Допустимые значения:	appliances, connectedClusters, managedClusters, provisionedClusters

--name -n

Имя экземпляра расширения.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Имя поставщика ресурсов кластера для этого clusterType (требуется для подготовкиclusters).

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False

az k8s-extension troubleshoot

Предварительный просмотр

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Выполните диагностические проверки расширения Kubernetes.

Эта команда используется для устранения неполадок расширения Kubernetes. Он собирает журналы и другие сведения, которые можно использовать для диагностики проблем с расширением.

az k8s-extension troubleshoot --name
                              --namespace-list
                              [--kube-config]
                              [--kube-context]
                              [--skip-ssl-verification]

Примеры

Устранение неполадок с расширением Kubernetes

az k8s-extension troubleshoot --name extension-name --namespace-list "namespace1,namespace2"

Обязательные параметры

--name -n

Имя расширения Kubernetes.

--namespace-list

Разделенный запятыми список пространств имен для устранения неполадок.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--kube-config

Путь к файлу конфигурации kube. Если он не указан, будет использоваться файл конфигурации kube по умолчанию.

--kube-context

Контекст Kubeconfig с текущего компьютера. Если не указано, будет использоваться текущий контекст из файла конфигурации kube.

--skip-ssl-verification

Пропустить проверку SSL для любого подключения к кластеру.

Свойство	Значение
Default value:	False

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False

az k8s-extension update

Обновите изменяемые свойства расширения Kubernetes.

Сведения об обновлении ConfigSettings и ConfigProtectedSettings см. в документации службы расширений кластера для проверки обновления этих свойств перед обновлением этих свойств. Выходные данные включают секреты, которые необходимо защитить. Убедитесь, что эти секреты не включены в систему управления версиями. Кроме того, убедитесь, что секреты отсутствуют в журналах команды или скрипта. Подробнее см. в статье http://aka.ms/clisecrets.

az k8s-extension update --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --name
                        --resource-group
                        [--auto-upgrade --auto-upgrade-minor-version {false, true}]
                        [--cluster-resource-provider --cluster-rp]
                        [--config --configuration-settings]
                        [--config-file --config-settings-file]
                        [--config-protected --config-protected-settings]
                        [--config-protected-file --config-protected-settings-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 или подготовленныеclusters.

Свойство	Значение
Допустимые значения:	appliances, connectedClusters, managedClusters, provisionedClusters

--name -n

Имя экземпляра расширения.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Автоматическое обновление дополнительной версии экземпляра расширения.

Свойство	Значение
Parameter group:	Version Arguments
Допустимые значения:	false, true

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

Имя поставщика ресурсов кластера для этого clusterType (требуется для подготовкиclusters).

--config --configuration-settings

Параметры конфигурации в качестве пары key=value. Повторите параметр для каждого параметра. Не используйте это для секретов, так как это значение возвращается в ответ.

Свойство	Значение
Parameter group:	Configuration Arguments

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

Путь к файлу JSON для параметров конфигурации.

Свойство	Значение
Parameter group:	Configuration Arguments

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

Защищенные параметры конфигурации в качестве пары key=value. Повторите параметр для каждого параметра. Только ключ возвращается в ответ, значение не является.

Свойство	Значение
Parameter group:	Configuration Arguments

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

Путь к JSON-файлу для параметров, защищенных конфигурацией.

Свойство	Значение
Parameter group:	Configuration Arguments

--config-settings

Не рекомендуется

Параметр "--config-settings" устарел и будет удален в будущем выпуске. Вместо этого используйте "--configuration-settings".

Параметры конфигурации в качестве пары key=value. Повторите параметр для каждого параметра. Не используйте это для секретов, так как это значение возвращается в ответ.

Свойство	Значение
Parameter group:	Configuration Arguments

--configuration-protected-settings

Не рекомендуется

Параметр "--configuration-protected-settings" устарел и будет удален в будущем выпуске. Вместо этого используйте "--config-protected-settings".

Защищенные параметры конфигурации в качестве пары key=value. Повторите параметр для каждого параметра. Только ключ возвращается в ответ, значение не является.

Свойство	Значение
Parameter group:	Configuration Arguments

--configuration-protected-settings-file

Не рекомендуется

Параметр "--configuration-protected-settings-file" устарел и будет удален в будущем выпуске. Вместо этого используйте "--config-protected-file".

Путь к JSON-файлу для параметров, защищенных конфигурацией.

Свойство	Значение
Parameter group:	Configuration Arguments

--configuration-settings-file

Не рекомендуется

Параметр "-configuration-settings-file" устарел и будет удален в будущем выпуске. Вместо этого используйте "--config-settings-file".

Путь к файлу JSON для параметров конфигурации.

Свойство	Значение
Parameter group:	Configuration Arguments

--no-wait

Не ожидать завершения длительной операции.

Свойство	Значение
Default value:	False

--release-train

Укажите обучение выпуска для типа расширения.

Свойство	Значение
Parameter group:	Version Arguments

--version

Укажите версию для экземпляра расширения, если не включена версия --auto-upgrade-minor-version.

Свойство	Значение
Parameter group:	Version Arguments

--yes -y

Игнорировать запросы подтверждения.

Свойство	Значение
Default value:	False

Глобальные параметры

--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство	Значение
Default value:	False

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство	Значение
Default value:	False

--output -o

Формат вывода.

Свойство	Значение
Default value:	json
Допустимые значения:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство	Значение
Default value:	False