Модуль azure.azcollection.azure_rm_aksupgrade_info – Получение доступных версий обновления для экземпляра AKS

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_aksupgrade_info.

Добавлена в azure.azcollection 1.4.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

Получение доступных версий обновления для управляемого экземпляра Azure Container Service (AKS).

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.7
Хост, на котором выполняется этот модуль, должен иметь установленную коллекцию azure.azcollection через galaxy
Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user string	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.
adfs_authority_url string added in azure.azcollection 0.0.1	URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и собственным узлом ADFS.
api_profile string added in azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. Default: `"latest"`
auth_source string added in azure.azcollection 0.0.1	Управляет источником учетных данных, используемых для аутентификации. Также может быть установлен через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `auto` (по умолчанию) приоритет имеет параметры модуля -> `env` -> `credential_file` -> `cli`. При установке в `env`, учетные данные будут считываться из переменных среды При установке в `credential_file`, профиль будет считываться из `~/.azure/credentials`. При установке в `cli`, учетные данные будут получены из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию. При установке в `msi`, хост-машина должна быть ресурсом Azure с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлен через переменную среды `AZURE_CLIENT_ID`.
cloud_environment string added in azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. Default: `"AzureCloud"`
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в True, проверка узла отключается. В результате важно убедиться, что настроенный узел является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string / required	Имя управляемого экземпляра Azure Container Services (AKS).
password string	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group string / required	Имя группы ресурсов, где существует управляемый Azure Container Services (AKS).
secret string	Секретный ключ клиента Azure. Используйте при аутентификации с главным субъектом безопасности.
subscription_id string	Ваш идентификатор подписки Azure.

арендатор строка	Идентификатор аренды Azure. Используется при аутентификации с помощью принципала службы.
отпечаток_ключа строка добавлен в azure.azcollection 1.14.0	Отпечаток закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью принципала службы. Обязательно, если определен x509_certificate_path.
x509_certificate_path путь добавлен в azure.azcollection 1.14.0	Путь к X509 сертификату, используемому для создания принципала службы в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью принципала службы.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или выполнить вход перед запуском задач или плейбука с помощью az login.
Аутентификация также возможна с помощью принципала службы или пользователя Active Directory.
Для аутентификации через принципала службы передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные могут быть сохранены в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

Авторизация с помощью Azure CLI: Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: Get available upgrade versions for AKS instance
  azure_rm_aksupgrade_info:
    name: myAKS
    resource_group: myResourceGroup
  register: myAKSupgrades

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
azure_aks_upgrades сложный	Поддерживаемые версии AKS-инстансов для обновления пулами агентов и контрольной плоскостью. Возвращается: всегда
agent_pool_profiles сложный	Доступные версии обновлений для пулов агентов Возвращается: всегда
kubernetes_version строка	Текущая версия kubernetes Возвращается: успешно Пример: `"1.18.1"`
name строка	Имя пула Возвращается: успешно Пример: `"my_pool"`
os_type строка	Тип операционной системы Возвращается: успешно Пример: `"Linux"`
upgrades сложный	Список доступных типов и версий оркестраторов для обновления. Возвращается: успешно
is_preview логическое	Доступна ли версия в предварительной версии Возвращается: успешно
kubernetes_version строка	Версия Kubernetes Возвращается: успешно Пример: `"1.19.3"`
control_plane_profile сложный	Доступные версии обновлений для контрольной плоскости Возвращается: всегда
kubernetes_version строка	Текущая версия kubernetes Возвращается: успешно Пример: `"1.18.1"`
name строка	Имя пула Возвращается: успешно Пример: `"my_pool"`
os_type строка	Тип операционной системы Возвращается: успешно Пример: `"Linux"`
upgrades сложный	Список доступных типов и версий оркестраторов для обновления. Возвращается: успешно
is_preview логическое	Доступна ли версия в предварительной версии Возвращается: успешно
kubernetes_version строка	Версия Kubernetes Возвращается: успешно Пример: `"1.19.3"`

Авторы

Andrii Bilorus (@ewscat)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_aksupgrade_info_module.html